Yggdrasil/README.md

Yggdrasil

A knowledge base migrated to Calepin, a Typst-based static site generator.

Quick Start

1. Dependencies: You need the just command runner.
2. Bootstrap Toolchain: Run just tools. This downloads pinned versions of calepin and typst into the tools/ directory. No global installation is required.
3. Build: Run just build to generate the static site in the public/ directory.
4. Preview: Run just preview or just watch to view the site locally.

Adding Content

• Source files are located in site/.
• To add a page, create a .typ file and link it in the site/calepin.toml configuration under [sidebar] or [pages].
• Categories are structured as subdirectories (e.g., site/thermo/) with their own index.typ.

Deployment

The site is built as a set of static files in the public/ folder. A Gitea Actions workflow .gitea/workflows/build.yml runs on push to build and upload these files as an artifact. They can be deployed to any static host.