I create a few diagrams of links across Typst Documentation by leveraging Graphviz.
TIP: Texts in these diagrams are real
<svg:text>tags, and are annotated with links to the official documentation. Unfortunately, this forum cannot render them properly. So I’ll put PNGs here. Click the image to go to the SVG version.
https://ydx-2147483647.github.io/typst-docs-links/
Tutorial (pink) & Guide (red)
In terms of how topics are organized, the current tutorial is satisfying.
- Writing in Typst introduces the foundational concepts—text, layout, math.
- Formatting adds more models and visualization.
- Advanced Styling links to Styling.
- Making a Template links to Scripting.
In addition, Guide for LaTeX Users provides an entrance to all the information for experienced people, while Table Guide and Page Setup Guide explore the corresponding topics specifically.
However, it should be noted that Context is totally neglected. There isn’t even a single link!
I heard that the Typst team is rewriting the tutorial. Hope it can be improved s∞n soon in Typst 0.14.
Introspection (violet blue)
Now let’s see pages on Introspection. Again, Context is kind of the elephant in the room. But this time, readers are clearly instructed at the title page:
Most of the functions are contextual. It is recommended to read the chapter on context before continuing here.
Foundations (orange)
You may have noticed that Foundations is heavily linked by Introspection. In fact other chapters are the same.
I guess it’s because there are too many things under Foundations…
Perhaps Foundations should be further split? For instance:
- Basic types: String, Boolean, Auto, Datetime, Type, …
- Debugging: Panic, Assert, Representation, Evaluate, …
- Programming: Arguments, Regex, Calculation, Module, Plugin, …
More chapters
Structures of other chapters lie between Introspection and Foundations.
Model (brown)
Text (black)
Layout (green)
Visualize (dark blue)
Math (sky blue)
Math is an exception. It’s quite flat, which means cross links are rare.
It’s partly because of the systematic intro on title page, but it also indicates that the math docs need improvement.
To name a few:
-
boldlives in Styles andbblives in Variants. They are often interchangeable in practice, but there’s no link between the two pages. -
Under/Over functions stretch brackets and lines.
Yesterday, someone (on a community platform) wanted to stretch the equal sign=. The answer lies in Stretch, but there was no hint in Under/Over. -
People without experience might be surprised that the appearance of
$sum_x$and$ sum_x $are different.
Yes, a sentence in the title page have explained it, but the details are scattered on Attach and Sizes, and they are not linked together. -
The size of Stretch might depend on its attachments, but Attach is not mentioned.
If you are willing to improve it, you can edit the files and submit pull requests to github.com/typst/typst.
No prior knowledge or local installation of the rust toolchain is required. (but be aware that Laurenz Mädje is very strict about wording :-)
If you encounter difficulties, you can refer to 📝 Memo: Editing typst.app/docs or ask on #Documentation | Discord.
All links
Please refer to Links across Typst Documentation or its git repo for more info.
Besides, links.json is also available for coding.