Getting Started

1. Sign in with GitHub

Go to app.mkdn.io and click Sign in with GitHub. We request read-only access to your public profile — we never request write access to your repositories.

2. Create a site

From the dashboard, click New site. You'll need:

  • GitHub repo — in owner/repo format (e.g. acme/docs). The repo must be public on the free plan.
  • Subdomain — the prefix for your site URL (e.g. acme → acme.mkdn.io). Subdomains must be lowercase alphanumeric with hyphens allowed.

Click Create site. mkdn.io fetches your repository's file tree and your site is live immediately.

3. Visit your site

Your docs are now live at yoursubdomain.mkdn.io. Navigate to any Markdown file path:

https://yoursubdomain.mkdn.io/           → renders your README.md
https://yoursubdomain.mkdn.io/guide      → renders guide.md or guide/index.md
https://yoursubdomain.mkdn.io/api        → renders api.md

Content negotiation

mkdn.io serves different content based on the HTTP Accept header:

Accept headerResponse
text/html (default browser)Rendered HTML page
text/markdownRaw Markdown file

AI tools and agents that send Accept: text/markdown get the raw source — perfect for RAG pipelines and LLM context.

4. Configure your site (optional)

From the dashboard, click your site name to open the Configure page. You can set:

  • Site title and branding
  • Color theme and typography
  • Custom domain
  • Navigation layout

See Configuration for details.

Next steps