UnmarkdownDocs

Custom URLs and Slugs

Configure custom URL slugs for readable, SEO-friendly published page addresses.

Default URLs

When you first publish a document, Unmarkdown auto-generates a URL slug from your document title. If the title is "Getting Started Guide," the slug becomes getting-started-guide:

text
https://unmarkdown.com/u/yourname/getting-started-guide
https://unmarkdown.com/d/getting-started-guide

If no title is set, a short unique ID is used instead. The auto-generated slug works immediately and is permanent unless you change it.

Custom Slugs

Pro users can replace the auto-generated slug with a custom one for better readability and SEO:

text
https://unmarkdown.com/u/yourname/api-reference
https://unmarkdown.com/u/yourname/2026-product-roadmap

Set your custom slug in the publish settings panel before or after publishing, or via the slug parameter in the API.

Important
Custom slugs are a Pro feature. Free plan users use the auto-generated slug from their document title.

Slug Rules

Slugs (both auto-generated and custom) must follow these rules:

  • Lowercase letters, numbers, and hyphens only
  • Must start with a letter or number
  • Between 3 and 60 characters long
  • No spaces, underscores, or special characters
  • Must be unique per user (no two of your documents can share a slug)
Tip
Use descriptive slugs like getting-started-guide or api-reference rather than generic ones. Good slugs improve SEO and make links more recognizable when shared.

Username URLs

If you have set a username in your profile, your published documents are accessible through your profile URL:

text
https://unmarkdown.com/u/yourname
https://unmarkdown.com/u/yourname/getting-started-guide

Your profile page at unmarkdown.com/u/yourname lists all your publicly visible documents. Each document can be accessed directly by appending its slug to your profile URL.

Changing Slugs

You can change a published document's slug at any time through the publish settings panel. The old URL stops working immediately and the new URL becomes active.

Warning
Changing a slug breaks existing links. Unmarkdown does not set up redirects from old slugs to new ones. If your document has been shared widely, consider keeping the original slug.

If you change a slug and then change it back, the original URL will work again, provided no other document has claimed that slug in the meantime.

Setting Slugs via API

When publishing via the API, pass the slug parameter to set a custom slug:

bash
curl -X POST https://api.unmarkdown.com/v1/documents/doc_abc123/publish \
  -H "Authorization: Bearer um_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "slug": "my-custom-slug" }'

Omitting the slug parameter uses the auto-generated slug from the document title.

Publishing OverviewVisibility