Documentation Page

Documentation Page turns the markdown already sitting in your Github repository into a gorgeous documentation website, with little or no setup. Talk about dogfeeding 🤗. The page you are reading right now is generated by it.

There is no build step and nothing is copied into your repo: we read your files on demand, render them, and serve a fast, searchable site. Push a change and it shows up (see the refresh rate).

Getting started

There is a good chance your documentation already works. Try it by searching your repository on the homepage, or go straight to:

https://documentation.page/github/<user>/<repo>/

For example: documentation.page/github/sindresorhus/meow.

Organize your docs

From the simplest to the most flexible, you can structure your documentation in three ways:

• A single readme.md. Ideal for smaller projects: write everything in your readme and call it a day. See example.
• A documentation/ folder with multiple markdown files. Every .md inside is concatenated (alphabetically, top-level files first) into a single page. Prefix files with numbers to control the order.
• A configuration file when you want control over the name, logo, menu, which files to include, a blog, and more. See Configuration.

documentation/
  1. Getting started.md
  2. Configuration.md
  3. Advanced.md

We follow your existing structure automatically, building the navigation from your headings. Most of what we detect is described in Conventions, and everything you can override lives in Configuration.

Custom branding

Every public repository is available on Documentation Page for free, so anyone can read and learn from it. Upgrading to a paid plan lets you point your own custom domain at it, put your brand front and center (logo, menu, a custom landing page), and get a faster refresh rate. See the pricing and the custom domain below.

Custom domain

On a paid plan you can serve your docs from your own domain, like docs.yourproject.com, with your branding front and center.

1. Register your domain (anywhere you like) and subscribe to a paid plan.
2. Contact me with your custom domain and your repo.
3. We reply with the CNAME record to add at your DNS provider.
4. Add a menu to your configuration so your site has top navigation, and optionally a home or landing page.

Your documentation is then served at the root of your domain, with your generated docs available under /documentation.

sitemap.xml and llms.txt

On a custom domain we automatically serve two extra files at the root, so search engines and AI tools can discover your content. They are generated for you, kept up to date, and require no configuration.

• /sitemap.xml: every page of your site (docs, blog posts and extra pages), for search engines.
• /llms.txt: your full documentation as a single markdown file, for LLMs and AI assistants.

Both are available only on custom domains.

Leaving Documentation Page

Documentation Page exists to help developers semi-automate their docs, not to lock them in. If you ever decide to move to, say, Github Pages, you can. There are some disadvantages, but they might not affect you.

The easiest path is to keep a single markdown file with all your docs, then either run a small script that converts it to HTML locally, or use a Jekyll template that renders it to HTML on Github Pages.