summaryrefslogtreecommitdiff
path: root/docs/typ/README
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-01 00:04:08 -0300
committerGabriel Schneider <[email protected]>2026-10-01 00:12:18 -0300
commit9ad4d38746dfacdf4921949e1c8bd050a0817cc7 (patch)
tree153e7027798713ccdc27cb08c656213f871c5acd /docs/typ/README
parent06770c54a408057c92c0381b75039d70c85625d6 (diff)
downloadpardes-9ad4d38746dfacdf4921949e1c8bd050a0817cc7.tar.gz
pardes-9ad4d38746dfacdf4921949e1c8bd050a0817cc7.zip
The book and the HTML gain "Setting up your environment" after the guide
chapters lists setup.typ second and #doc takes a setup id. Shell lines (#cmd) follow the density too: roomy in the book and the HTML, with a tint and space around them, tight on the A4 sheet; the book sets code blocks on the same tint. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/typ/README')
-rw-r--r--docs/typ/README4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/typ/README b/docs/typ/README
index 509cec39..048e5d01 100644
--- a/docs/typ/README
+++ b/docs/typ/README
@@ -14,7 +14,7 @@ docs/typ: the Typst documentation corpus
an anchor named by its id, then the tutor.
Wrappers hold layout only, never facts.
-Chapters: `chapters` in style.typ lists them in reading order (guide,
+Chapters: `chapters` in style.typ lists them in reading order (guide, setup,
cheatsheet, scripting, reference, themes, building), each with its content file,
or none while it is not written (the outputs show a placeholder). To add
a topic, write docs/typ/<id>.typ and set its `file`. Wrappers include it
@@ -61,7 +61,7 @@ new function instead.
cmd(c) a shell line, as a block. #cmd("echo Save > $m/pane/$n/ctl")
doc(id, section:)
a pointer to a chapter, or a section of it by the label
- on its heading. Ids: guide cheatsheet scripting
+ on its heading. Ids: guide setup cheatsheet scripting
reference themes building (and the older tags fs
config keys detached, mapped in `topics`). A link in
the book and the HTML; on the A4 sheet, its name.