DocPatch Documentation - Getting Started

What is DocPatch?

DocPatch converts Markdown documentation between modern documentation frameworks. Transform your Markdown into Docusaurus, MkDocs, or GitBook format while preserving formatting, links, and metadata.

Individual Markdown documents convert in seconds via API. For larger migrations, use the API programmatically to batch-process your docs. It preserves metadata, links, and formatting throughout.

Supported Formats

      Input: Markdown only

      Output Frameworks: Docusaurus, MkDocs, GitBook

      Coming Soon (Q4 2026): Sphinx, Jekyll, HTML input support

Sign Up (Free)

Get your API key in 30 seconds — no credit card required:

Step 1: Sign Up

Get your free API key in 30 seconds. No credit card required.

Get Started Free

Step 2: Get Your API Key

After signup, your API key appears on the dashboard. Copy it right away — use it as the x-api-key header on every API request.

Step 3: Start Converting Docs

Use the live widget below to test with sample docs, or call the API directly with your key.

Your First Migration

Let's migrate a single document to test the API. You can also just use the live widget above instead of calling the API directly.

Step 1: Prepare Your Document

Currently Supported:

Input Format: Markdown only
Output Frameworks: Docusaurus, MkDocs, GitBook
Preserves: Formatting, links, metadata, nested sections

Coming Soon (Q4 2026): Sphinx and Jekyll framework support, HTML/TXT input conversion, Confluence API integration.

If your docs are in another format (Word, PDF, HTML, Confluence, Notion), export or convert them to Markdown first — DocPatch works with any valid Markdown source.

Step 2: Make Your First API Call

Send a POST request to the DocPatch API with your markdown. This is the real, live endpoint — same one the widget above calls:

curl -X POST https://api.docpatch.dev/v1/docpatch/migrate \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "markdownContent": "# Getting Started\n\nThis is a sample doc...",
    "targetFramework": "docusaurus"
  }'
    

Step 3: Get Your Result

The call is synchronous — no batch ID, no polling, no webhooks. You get your converted document directly in the response:

{
  "status": "success",
  "migratedDocument": "---\ntitle: Getting Started\n---\n\n# Getting Started\n\nThis is a sample doc..."
}
    

Usage Limits

Each call converts one document. Your plan sets how many you can convert per month, not how many fit in a single request:

      Free: 100 conversions/month

      Growth ($39/mo): 500 conversions/month

      Scale ($149/mo): 5,000 conversions/month

Common Use Cases

Migrating from Confluence or Notion

Export your Confluence or Notion workspace as Markdown (built-in export feature). Use DocPatch to convert to your target framework (Docusaurus, MkDocs, GitBook, etc.) and publish. Batch processing via API for large migrations.

Framework Normalization

Your docs are scattered across Docusaurus, MkDocs, and GitBook. Use DocPatch to normalize everything to a single framework for consistency and easier maintenance.

Documentation Standardization

Consolidate Markdown from multiple sources into a single format. DocPatch preserves links, code blocks, tables, and formatting while adapting to your target framework's conventions.

Pricing

Plan	Docs/Month	Cost	Best For
Free	100	$0	Testing, small projects
Growth	500	$39/month	Growing teams, monthly migrations
Scale	5,000	$149/month	Enterprise, frequent migrations

No overage charges. When you reach your monthly quota, the API returns a 402 status. Your quota resets monthly; upgrade anytime to increase your limit.

Troubleshooting

Q: "Invalid API Key" Error

A: Re-copy the key from your original verification email — it's only shown once and there's no Settings page to view it again yet. Make sure there are no extra spaces. API keys are case-sensitive.

Q: My Request Is Taking a Long Time

A: Each API call converts one document synchronously — there's no batch mode, job ID, or polling yet. If a single call is hanging longer than a minute or two, contact support rather than waiting.

Q: "Unsupported Format" Error

A: DocPatch currently only accepts Markdown input. If your source is in another format (Word, PDF, HTML, Confluence, Notion), please convert or export it to Markdown first.

Q: How Do I Update My API Key?

A: Key rotation isn't self-serve yet — contact support to have your key reissued. Your old key stops working once the new one is issued, so update all apps using it.

Next Steps

Read the full API reference: Full endpoint documentation with all parameters and response codes.
Batch mode & webhooks: on the roadmap — not live yet. Every call today is a single, synchronous conversion.
Usage tracking: call GET /v1/usage on the auth service with your x-api-key header for your remaining quota and a call-count breakdown by endpoint. A full self-serve dashboard is still on the roadmap.
Join our Slack community: Connect with other developers using DocPatch.

Ready to migrate? Start with 100 free docs to test. No credit card. Upgrade when you're ready.

Subscribe: Growth $39/mo → Subscribe: Scale $149/mo →

← Back to Home

📄 DocPatch Getting Started