Welcome to MkDocs
Roamlink: about yourself.
For full documentation visit mkdocs and MkDocs Material theme websites.
Commands¶
mkdocs new [dir-name]- Create a new project.mkdocs serve- Start the live-reloading docs server.mkdocs build- Build the documentation site.mkdocs -h- Print help message and exit.
Project layout¶
.github/ # Github actions
...
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
blog/ # Blog folder
posts/ # Blog posts folder
includes/
examples.md # The files to be included in other files in `docs/`
...