Skip to content

Documentation Pages

To add a new page to the documentation:

  1. Create a Markdown (.md) file in an appropriate location in the docs/ folder;
  2. Add the page to the nav element in the mkdocs.yml file 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 nav element 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.


Last update: 2021-11-15
Back to top