This documentation uses Markdown, so you can edit it in a normal text editor. Also have a look at the common extensions and plugins used to make the documentation a rich experience.
When adding pages, they may not automatically show up in the navigation. If that
is the case you may want to add them to a
navigation.md file in the directory
containing the file, or any of its parents. This directory must be referenced by
navigation.md file, or live in one of the top-level sections (the ones
visible in the header bar). In them, the navigation can be defined like this:
This decentralized navigation definition in Markdown files is made possible
A directory can be included as subsection too:
*) can be used to include any remaining
files. Prefer including whole directories and wildcard characters over explicit
navigation entries, since new files will automatically show up this way.
Simply place images in the directory of the Markdown file(s) using them. This way images can be referenced there by name only, rather than an actual relative path, and they are as close as possible to the content using them.
In Markdown you can use the usual syntax to emplace images. One difference is that images will be centered by default for convenience.
To add a caption to the image, fill in the alt text as follows:
Left or right align:
For side-by-side images use a table:
To add a video:
To add a caption to a video:
Only basic/common editing was covered here. The following resources contain a lot more information on how to write rich documentation using Material for MkDocs: