zetl

Build Command

zetl build generates a static HTML site from your vault, with the same look and feel as Serve Command minus the edit button and save functionality.

Usage

zetl -d ./my-vault build                  # generates dist/
zetl -d ./my-vault build --out-dir site   # custom output directory

Flags

FlagDefaultDescription
--out-dir <path>distOutput directory for the generated site

Output structure

dist/
  index.html              # vault overview with stats and page grid
  page/
    Some Page/index.html   # one page per note
    Another/index.html

Features

  • Rendered Markdown with syntax highlighting
  • Backlink lists on each page
  • Transclusion panels with SVG bridge connectors
  • Page grid on the index page
  • Clean URLs (/page/Scanner/ instead of /page/Scanner.html)

Deployment

The output can be uploaded to any static host:

  • GitHub Pages
  • Netlify
  • S3 + CloudFront
  • Any web server

Preview locally:

python3 -m http.server -d dist 8080

See also: CLI Reference, Serve Command, View Command

Backlinks