How to docs
Configuring docs
Configure the docs in the mkdocs.yml file in the Material for MkDocs directory
\\PATTAROSNAS\Varie\mkdocs-material\mkdocs.yml
site_name: Pacta docs
site_url: https://docs.thepacta.net/
# Themes and colors
theme:
...
# Extensions
markdown_extensions:
...
# Page tree
nav:
...
Editing docs
To edit the documentation you can directly edit the MarkDown files in the Material for MkDocs directory
\\PATTAROSNAS\Varie\mkdocs-material\docs\index.md
# Welcome to the docs
A *full* and *detailed* guide to all of the **The Pacta** network and infrastructure
Im writing some new docs!
Adding docs
-
Add the MarkDown file in the Material for MkDocs directory and write some docs
-
Modify the
mkdocs.ymlfile in the Material for MkDocs directory to include in the nav the newly added docs\\PATTAROSNAS\Varie\mkdocs-material\mkdocs.yml# Page tree nav: - Home: index.md ... - Example: example.md
Warning
If you don't put the newly added files in the nav section of the mkdocs.yml file THEY WILL NOT SHOW UP IN THE WEBSITE