Guides

Practical, task-oriented how-tos. For the reference material, see Conventions and Configuration.

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.

Organizing multiple pages

Keep your docs in a documentation/ folder and number the files to control their order:

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

All of them are concatenated into a single page, and the navigation is built automatically from your headings. To crawl a custom set of files and folders instead, list them with the documentation option.

Moving out of 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.