cspogil.org

The website is built with MkDocs using the Material theme, the Awesome Nav plugin, and the mkdocs-redirects plugin. Deployment to GitHub Pages is automated via GitHub Actions.

Dev Setup

Create a Python virtual environment:

python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate.bat

Install the required Python packages:

$ pip install --upgrade pip
$ pip install --pre -r requirements.txt

Using MkDocs

To preview the site locally while editing:

$ mkdocs serve

Then open http://127.0.0.1:8000/ in your browser. Whenever you save a file under the docs directory, the site will automatically reload.

References

• Basic Syntax | Markdown Guide
• Reference - Material for MkDocs
• Reference - Awesome Nav for MkDocs

Acknowledgments

• light-bulb.png is Light Bulb free icon by Freepik. Free for personal and commercial purpose with attribution.
• favicon.ico was created with: convert light-bulb.png -define icon:auto-resize=64,48,32,16 favicon.ico