Quickstart
Sign up, create an API key, and publish your first document in under 5 minutes.
Step 1: Sign up
Go to unmarkdown.com and click "Start free." You can sign up with your email (magic link, no password needed) or with Google or GitHub OAuth.
Step 2: Create an API key
Open Settings, go to the API tab, and click "Create API key." Your key starts with um_ followed by 64 hex characters. Copy it immediately as it is only shown once.
Warning
Store your API key securely. It cannot be retrieved after creation. If lost, revoke it and create a new one.
Step 3: Publish your first document
Use the API to publish a markdown document. The response includes the published URL.
bash
curl -X POST https://api.unmarkdown.com/v1/documents/publish \
-H "Authorization: Bearer um_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"content": "# Hello World\n\nMy first published page.",
"template_id": "swiss"
}'Tip
Pro users can pass a custom slug field (for example, "hello-world") to choose the URL path. Without it, the system generates a slug from the document title automatically.
Step 4: View your published page
The response includes a published_url field with the URL of your page. Open it in your browser to see your published document.
json
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"title": "Hello World",
"published_url": "https://unmarkdown.com/u/yourname/hello-world-a1b2c3",
"published_at": "2026-02-15T12:00:00Z",
"template_id": "swiss",
"word_count": 6,
"reading_time_minutes": 1
}Next steps
Now that you have published your first document, explore the full platform: