summaryrefslogtreecommitdiff
path: root/docs/typ/README
diff options
context:
space:
mode:
Diffstat (limited to 'docs/typ/README')
-rw-r--r--docs/typ/README12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/typ/README b/docs/typ/README
index 5db2cf76..9d3913c0 100644
--- a/docs/typ/README
+++ b/docs/typ/README
@@ -35,7 +35,7 @@ Build (from the repo root):
The contract for content files
------------------------------
Start a content file with
- #import "style.typ": key, keys, btn, chord, word, tag, addr, file, cmd, doc, pairs, fstree
+ #import "style.typ": key, keys, btn, chord, word, tag, addr, file, cmd, doc, pairs, fstree, annotated, mode-box
(a content file does not import page setup; the same file goes into the
book, the HTML and, for the cheatsheet, the A4 page)
and use plain markup (= headings, - lists, `raw`, *strong*) plus these.
@@ -82,6 +82,16 @@ new function instead.
pane/
new open: a new pane @panes
```)
+ annotated(src, size, alt:, ..pins)
+ a screenshot with numbered pins, their labels as text
+ beside it. src from the repository root, size in
+ pixels, each pin ([label], x, y) in its pixels.
+ #annotated("/docs/site/media/themes/orchard.png", (640, 513),
+ alt: "a pardes window", ([the box], 8, 58))
+ mode-box(mark, unsaved:)
+ a pane's box as it looks: " " normal, "^" insert,
+ "$" raw; unsaved: true fills it.
+ #mode-box("^") #mode-box(" ", unsaved: true)
theme-gallery() every theme as a picture, on the site's Themes page;
nothing on paper.
pairs(split:, ..cells)