summaryrefslogtreecommitdiff
path: root/docs/site/README
blob: 76c2973f7a018e2bcbdc170711dee0dc5b49532f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
docs/site: the pardes website, built from docs/typ

  site.typ         the wrapper: every page, the shared tag-line header and
                   chapter nav, the landing page, and the files it ships.
                   Pages come from `chapters` in ../typ/style.typ, so a new
                   chapter is a new page; #doc links resolve across pages.
  site.css         the whole look (lapis layout from 0x4200.cafe in
                   pardes's orchard greens; forestbones_light when the
                   reader prefers light).
  fonts/           Departure Mono and Crimson Pro, both SIL OFL, licences
                   alongside.
  media/clips.toml the landing page's recordings, in order: name, caption,
                   ready. For a clip named N the site ships media/N.webm,
                   media/N.mp4 and media/N.png (the poster); until `ready`
                   is true it shows placeholder.svg instead.

Build (from the repo root):

  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/

Every page sits at the top of OUT and every link is relative, so the site
works from file:// and from any static server. The only prose of the
site's own is the landing page; everything else is included from docs/typ.