Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 970 Bytes

File metadata and controls

46 lines (33 loc) · 970 Bytes

File Naming

  • Snake-case for all files and folders (e.g., my_file.py, my_folder)

Commit Messages

[optional issue id]: <description>

[optional body]

[optional footer(s)]

Examples:

* [`#19`] - Add the operator precedence examples
* [`#####`] - Move the image assets to a dedicated folder

Building the MkDocs Site

Follow these steps to generate the static documentation using MkDocs.

  1. Install the required Python packages:
    pip install -r requirements.txt
  2. Build the site:
    mkdocs build
    The generated files will appear in the site/ directory.
  3. To preview the documentation locally, run:
    mkdocs serve

Navigation is created automatically by the mkdocs-awesome-pages-plugin based on files inside the docs/ folder.