creating new mkdocs pages
How to add a new Page
- Create a new
.mdfile under in thedocs/folder - Add the new page to the
mkdocs.ymlfile under thenavsection - Do not put
docs/prefix on the filepath - Commit and push your changes to the
mainbranch - 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
python3is installed - Install python requirements
- Clone the repository &
cdinto it - Run the local server