creating new mkdocs pages
How to add a new Page
- Create a new
.md
file under in thedocs/
folder - Add the new page to the
mkdocs.yml
file under thenav
section - Do not put
docs/
prefix on the filepath - Commit and push your changes to the
main
branch - GitHub Action will automatically build and deploy the changes to the website.
About this website
Stack
Name | Description |
---|---|
mkDocs | Docs static site generator |
Material for MkDocs | Material theme for mkDocs |
Steps to run it locally
- Make sure
python3
is installed - Install python requirements
- Clone the repository &
cd
into it - Run the local server