Ship your API docs with one command

Your API docs are already in markdown. Publish them as clean, readable pages without setting up a docs framework.

Docs frameworks are overkill for most APIs

You have a REST API. You wrote the docs in markdown because that's what makes sense. Now you need to put them somewhere people can read them.

The typical advice is to set up Docusaurus, MkDocs, or Mintlify. That means a separate repo (or a subfolder with its own build), a deploy pipeline, a config file, and a theme you will spend too long customizing. For a 20-page API reference, that's a lot of overhead.

MDtoLink takes a different approach. Run mdtolink publish docs/api.md and your docs are live. Add it to CI and they stay current. That's the whole setup.

How to publish API docs

1. Publish your docs

# Publish individual doc files
mdtolink publish docs/quickstart.md --slug api-quickstart
mdtolink publish docs/authentication.md --slug api-auth
mdtolink publish docs/endpoints.md --slug api-reference

Each file gets its own URL. Link between them using standard markdown links.

2. Auto-update from CI/CD

# .github/workflows/docs.yml
name: Publish API Docs
on:
  push:
    branches: [main]
    paths: ['docs/**']

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm install -g mdtolink
      - run: |
          mdtolink publish docs/quickstart.md --slug api-quickstart
          mdtolink publish docs/authentication.md --slug api-auth
          mdtolink publish docs/endpoints.md --slug api-reference
        env:
          MDTOLINK_API_KEY: ${{ secrets.MDTOLINK_API_KEY }}

Trigger on pushes to docs/** so your published pages always match the code.

3. Add a custom domain (optional)

On the Publisher plan, point docs.yourapi.com to MDtoLink with a CNAME record. SSL is automatic. Your API consumers see your brand, not ours.

Built for technical content

MDtoLink renders your markdown with full support for the things API docs actually need:

  • Syntax-highlighted code blocks

    JSON, cURL, Python, JavaScript, Go, and every other language your API consumers use. Fenced code blocks render with proper highlighting.

  • GFM tables

    Perfect for endpoint parameter tables, response field descriptions, and status code references.

  • Anchor links and headings

    Each heading gets an anchor, so you can link directly to /d/api-reference#create-user from your README or support tickets.

  • Inline code and task lists

    Mark up parameter names, HTTP methods, and status codes. Use task lists for integration checklists.

When MDtoLink makes sense for API docs

MDtoLink is not trying to replace Swagger UI or full docs platforms. It's for a specific situation: you have markdown docs and you want them online fast, with zero config.

Good fits: internal APIs, early-stage products, side projects, partner integrations where you need to share docs quickly, and any case where a full docs framework feels like too much.

If you eventually outgrow it and need versioning, search, or an API playground, you can migrate to a dedicated docs tool later. Your markdown files are yours; MDtoLink never locks you in.

Frequently Asked Questions

Can I publish multiple markdown files as separate API doc pages?
Yes. Each markdown file becomes its own URL. Publish your authentication docs, endpoint reference, and quickstart guide as separate documents, then link between them using standard markdown links.
Does MDtoLink support syntax highlighting in code blocks?
Yes. Fenced code blocks with language identifiers (like ```json or ```bash) are rendered with full syntax highlighting.
Can I use a custom domain for my API docs?
Yes, on the Publisher plan. Set up a CNAME record pointing to mdtolink.com, and your docs are served from your own domain with automatic SSL. For example, docs.yourapi.com.
How do I keep my published docs in sync with my codebase?
Add mdtolink publish to your CI/CD pipeline. Every time you merge to main or tag a release, your docs update automatically. The CLI and REST API both support authentication via API keys.

Publish your API docs in 30 seconds

Free to start. No config files, no build step, no deploy pipeline.

Start Publishing Free Read the Docs