Skip to content

creating new mkdocs pages

How to add a new Page

  1. Create a new .md file under in the docs/ folder
  2. Add the new page to the mkdocs.yml file under the nav section
  3. Do not put docs/ prefix on the filepath
  4. Commit and push your changes to the main branch
  5. 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

  1. Make sure python3 is installed
  2. Install python requirements
    pip install mkdocstrings[python]
    pip install mkdocs-material
    
  3. Clone the repository & cd into it
  4. Run the local server
    mkdocs serve