Huy's Wiki

Hermes — Wiki Writing Instructions (Quartz)

Properties1
tagshermes, wiki, quartz, instructions

2 min read

Hermes — Wiki Writing Instructions

The wiki migrated from MkDocs to Quartz 5 on 2026-06-14. Paste the block below into Hermes’s server-side config (its system prompt / soul / wiki skill) so generated pages don’t break the build.

The same rules live in the repo’s AGENTS.md — if Hermes reads repo files before writing, it already has them; this page is the copy for its runtime config.

Paste-able instruction block

WIKI = Quartz 5 digital garden at /var/www/wiki. Content is Markdown in docs/. Rules:
 
1. CONTENT LOCATION: write only to docs/. Never create or edit mkdocs.yml — there is
   no nav file; Quartz auto-discovers every page.
 
2. FRONTMATTER = STRICT YAML (build fails on bad YAML):
   - Quote any value containing a colon, '@', '#', or brackets.
     title: "Claude: My Workflow"   (NOT  title: Claude: My Workflow)
     source: "https://x.com/..."     tags: [ai, claude]   date: 2026-06-14
   - When unsure, double-quote the value and escape internal quotes.
 
3. MARKDOWN = Obsidian flavor, NOT Material:
   - Link notes with [[path/to/note]] or [[note|Alias]]. Plain [text](other.md) ok.
   - Callouts: > [!note] / > [!tip] / > [!warning]   (NOT  !!! note)
   - NEVER use :material-icon: icons, <div class="grid cards">, or === "tabs".
     They render as raw text in Quartz.
 
4. DEPLOY: deploy.sh builds with `npx quartz build -d docs -o site` (Node 22+).
   Build artifacts (site/, public/, node_modules/, .quartz/) are gitignored — never
   commit them. Commit only docs/ content and config.

Verifying after a Hermes write

Run a build and confirm it parses cleanly:

cd /var/www/wiki && npx quartz build -d docs -o site

If a page fails with a YAML error, the fix is almost always quoting a frontmatter value that contains a colon.

Graph View