Home¶
Welcome! This site is built with MkDocs and the
Material for MkDocs theme,
and published automatically to GitHub Pages on every push to main.
How this site works¶
Markdown files live in the docs/ folder of the repository. The navigation
is generated automatically from the folder structure:
- Top-level folders under
docs/become tabs in the top navigation bar. - Subfolders become collapsible sections in the left sidebar.
- Headings on each page become the anchor menu in the right sidebar.
Adding a new page¶
- Create a Markdown file anywhere under
docs/, e.g.docs/guides/my-page.md. - Start it with a single
# Heading— that becomes the page title. - Commit and push to
main. - GitHub Actions builds the site and deploys it to GitHub Pages in a minute or two.