Skip to content

Repository files navigation

laverty.io

Personal site built with MkDocs and Material for MkDocs, published to GitHub Pages at https://laverty.io/.

How it works

  • Markdown content lives under docs/.
  • Navigation is generated automatically from the folder structure: folders → collapsible left sidebar sections (collapsed by default), page headings → right sidebar anchor menu.
  • Pushing to main triggers the Deploy MkDocs to GitHub Pages workflow, which builds the site and deploys it to GitHub Pages.

Local development

Requires Python 3.x.

pip install -r requirements.txt   # once
mkdocs serve

Open http://127.0.0.1:8000 — the site live-reloads as you edit.

If port 8000 is taken (PermissionError: [WinError 10013] or "address already in use"), serve on another port:

mkdocs serve -a 127.0.0.1:8001 -w hooks

-w hooks makes edits to the Python build hooks trigger a rebuild too (content, config, and theme overrides are watched by default; hook code is not). If the browser shows stale content: check only ONE mkdocs serve is running — multiple can bind the same port on Windows and old ones keep answering — then hard-reload with Ctrl+Shift+R, or keep DevTools open with "Disable cache" ticked while developing.

To run the same build as CI (fails on broken internal links):

mkdocs build --strict

The output lands in site/ (git-ignored); it's a static site, so opening it via mkdocs serve is only needed for live reload.

Adding content

Drop a .md file anywhere under docs/, start it with a # Heading, then commit and push. To add a new sidebar section, create a new folder under docs/ with an index.md inside.

For a daily log entry, scaffold today's post and fill it in:

python new-daily.py

To add a video summary page (embedded YouTube video with an AI-generated summary below it; requires pip install yt-dlp and the claude CLI):

python new-video.py <youtube-url>

To generate an AI hero image for a page (requires a local ComfyUI instance and the claude CLI; settings in config.yaml):

python new-hero.py docs/<path-to-page>.md

In a Claude Code session, /write-article <topic> researches a topic on the web and creates a complete article page — filed, tagged, linked from its section index, with hero image and summary.

Folder structure, page conventions, and writing style are documented in CLAUDE.md.

Releases

Packages

Used by

Contributors

Languages