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 like 1. Intro.md, 2. Usage.md 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.

We follow your existing structure automatically. 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 guide.