MkDocs
Installation on macOS
Install mkdocs-material with pip
pip install mkdocs-material
Create new site
In my case the new site is called fossbyte
mkdocs new fossbyte
This will create the following structure:
.
├─ docs/
│ └─ index.md
│ └─ other-site.md
│ └─ 'name-of-site-with-subsites':
│ └─ 'SUBSITE_01': content-of-subsite_01.md
│ └─ 'SUBSITE_02': content-of-subsite_02.md
└─ mkdocs.yml
Site-build
mkdocs build
Output will be on the root folder and is named "site"
Serve site locally
To view the site in live-demo:
mkdocs serve
This serves the site on localhost
As soon as you change your site.md -> the live-demo is refreshed instantaneously