mkdocs-material-demo

Installation

1. python -m venv venv
2. .\venv\Scripts\activate
3. pip install -r requirements.txt
4. mkdocs new .
5. mkdocs serve

Tutorial

1. Change the site_name to what ever you want
2. Choose theme in theme: section (readthedocs, material,...)
3. Add feature, palette (color) to theme using features in theme: section
4. Markdown Extension: plain-text file format for .md (hightlighting code,...)
5. Add plugin in plugins: section (Notice: some plugin need to install more library via pip)
6. Go to https://github.com/owner/repo/settings/pages and config branch to gh-pages root and save