1# typst
2
3sublimated renders `.typ` files as multi-page documents. push via [git](../git/), view the rendered pages on the web.
4
5- documents compile to PDF + SVG pages on push — instant viewing, no client-side rendering
6- text is selectable and copyable (font-aware text overlay on SVG pages)
7- heading anchors for deep linking (e.g. `docs/typst/demo.typ#introduction`)
8- multi-file projects work — `#import`, `#include`, and `#image` resolve relative paths
9- block-level structure extracted for comments, diffs, and semantic analysis
10- edit mode uses CodeMirror (same as .ts, .py, etc)
11
12## demos
13
14one file per feature area — push them to see them rendered:
15
16- [basics](basics.typ) — headings, paragraphs, emphasis, lists
17- [math](math.typ) — equations, symbols, matrices, aligned expressions
18- [code](code.typ) — code blocks, inline code, syntax highlighting
19- [tables](tables.typ) — tables with headers, alignment, styling
20- [figures](figures.typ) — figures with captions, placement, numbering
21- [layout](layout.typ) — page setup, columns, spacing, breaks
22- [styling](styling.typ) — custom fonts, colors, show rules, set rules
23- [functions](functions.typ) — variables, functions, conditionals, loops
24- [bibliography](bibliography.typ) — citations and bibliography
25- [article](article.typ) — a complete article combining all features
26
27## how it works
28
291. push a `.typ` file via git (or save via edit mode)
302. sublimated sends it to the typst compiler (sbl-typst, based on typst v0.13)
313. three outputs are generated and stored in CAS:
32   - **PDF** — downloadable, printable
33   - **SVG pages** — one SVG per page for the web viewer
34   - **manifest** — semantic structure (headings, figures, equations, text runs)
354. the web viewer displays SVG pages with a transparent text layer for selection
365. heading anchors enable deep linking into the document
37
38## multi-file projects
39
40typst documents can import other files. sublimated clones the full folder context before compiling, so relative imports work:
41
42```typst
43#import "utils.typ": template
44#import "data.typ": results
45
46#show: template
47
48#include "chapters/intro.typ"
49```
50
51push your entire project folder — all imports resolve automatically.
52
53## embedding in markdown
54
55use content block transclusion to embed a rendered `.typ` document in markdown:
56
57```markdown
58/path/to/document.typ
59```
60
61the rendered pages appear inline.