30DaysOf MkDocs

Objective

Create a template repo that can be used for rapidly scaffolding 30DaysOf projects with mkdocs-material.

Motivation

Mkdocs-material provides a number of built-in or plugin-based features that check a lot of requirements for 30DaysOf projects. These include:

1. Rich components & styling (with Material Design)
2. Dark/Light Mode
3. Built-in Search
4. Markdown-based Content (with enhanced support)
5. Plugin-based Extensions (for rich integrations)
6. Built-in Cookie Consent (for Google Analytics)
7. Customizable navigation & default overrides
8. Support for Blog feature (via plugin)
9. Deployment to GitHub Pages (with GitHub Actions)
10. Python-based package (local preview, devcontainer support)

Usage

The best way to use this template is:

1. Instantiate it (using the Use this template feature)
2. Read through the sample workshop (source in docs/01-Workshop)
3. Use it to create your own materials (e.g., as docs/ subfolder)
4. Delete the docs/01-Workshop subfolder to remove the tutorial.
5. Commit changes and activate your default GitHub Pages settings in repo.

The next time you commit code, the GitHub Pages hosted endpoint should get rebuilt and redeployed automatically.

---