Skip to content

Note Template

Welcome to your fresh notebook. This site is powered by Zensical + mkdocs-material and is published automatically to GitHub Pages whenever you push to main.

How to use this template

  1. Click Use this template on GitHub, or clone this repo and repoint the remote.
  2. Edit mkdocs.yml — change site_name, site_url, repo_name, repo_url.
  3. Drop your notes anywhere under docs/. The left-hand navigation is generated automatically by the awesome-pages plugin.
  4. Commit and push. GitHub Actions will:
    • run pre-commit on every PR (markdown formatting, spell check, secret scan),
    • publish the rendered site to GitHub Pages.

Previewing locally

bash uv sync make serve # http://0.0.0.0:9987

Next steps

Start writing. Folders you create under docs/ (for example docs/notes/, docs/weekly/, docs/projects/, docs/references/) show up in the sidebar without any extra configuration.