How to add a new documentation page¶
To add a new page to the documentation:
- Create a Markdown (
.md) file in an appropriate location in the
Add the page to the
navelement in the
mkdocs.ymlfile in the root of the repository.
Overriding the title
By default, the title shown in the Table of Contents is the title of the page. To override this, specify a title in the
navelement explicitly. For example:
nav: - Home: - index.md - Installation: getting-started.md
By convention, the first page mentioned in
nav under a section should be some
index.md (without a title), and will be used as the index page (home page) for that section.