Guide
Guide
How to add the documentation system to a repository, write for it, publish it, customize it and keep it current.
On this page
The guide follows a project from the first command to the fiftieth release. Read it in order once; after that each page stands alone.
| Page | Read it when |
|---|---|
| Getting started | You are adding the site to a repository. |
| Writing documentation | You are writing or moving Markdown into docs/. |
| Publishing | You are a maintainer turning the site on, or want to know what the workflows do. |
| Customizing | The defaults are not enough: tokens, static files, a replaced component. |
| Upgrading | A new release of the package is out. |
| Troubleshooting | A command failed or a page looks wrong. |
| Migrating from the earlier starter | The repository has a docs-site/ copied from the starter. |
The reference has the complete lists: every config key, command, option, exit code and check.