diff options
Diffstat (limited to 'docs/typ/README')
| -rw-r--r-- | docs/typ/README | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/typ/README b/docs/typ/README index 048e5d01..522d99ff 100644 --- a/docs/typ/README +++ b/docs/typ/README @@ -10,8 +10,9 @@ docs/typ: the Typst documentation corpus cheatsheet-a4.typ output wrapper: the one-page A4 cheatsheet. book.typ output wrapper: an A4 book, title page, contents, every chapter, then the tutor (src/tutor.txt). - html.typ output wrapper: one HTML page, every chapter under - an anchor named by its id, then the tutor. + ../site/site.typ output wrapper: the website, a page per chapter plus + the landing page and the tutor, in one Typst bundle + run (see docs/site/README). Wrappers hold layout only, never facts. Chapters: `chapters` in style.typ lists them in reading order (guide, setup, @@ -27,7 +28,8 @@ Build (from the repo root): typst compile --ignore-system-fonts docs/typ/cheatsheet-a4.typ zig build cheatsheet -Dplatform=tty --prefix DIR # DIR/share/doc/pardes/cheatsheet.pdf typst compile --root . --ignore-system-fonts docs/typ/book.typ - typst compile --root . --features html --format html docs/typ/html.typ pardes.html + typst compile --root . --format bundle --features bundle,html docs/site/site.typ OUT + zig build site -Dplatform=tty --prefix DIR # DIR/share/doc/pardes/site/ (--root . because book and HTML read the tutor from src/tutor.txt.) The contract for content files |