I’m glad to introduce the website Typst Extra Docs:
Is it official or not?
The website is unofficial, but the contents are official.
Specifically, the website covers two kinds of contents.
- Typst’s official GitHub repositories (github.com/typst) contain some files that are missing in the official Typst Documentation (typst.app/docs). These files are collected here to help with reading and searching.
- Snapshots of the official Typst Documentation are also stored here, for reading offline or using previous versions.
Why not view on GitHub?
GitHub lists files in alphabetical order. If you want to read in the logical order, you have to navigate like this:
For comparison, here’s what it looks like on Typst Extra Docs:
Additionally, GitHub search is biased towards code and requires special notations to search for docs.
On the contrary, Typst Extra Docs uses the search function integrated in mdBook. The search result can update as you type, and is focused on docs.
A trivial project?
Yes, but it’s more complex I thought.
-
Links across files need to be remapped.
Absolute links to GitHub may have to be replaced with relative links within the website, while relative links in a repo may have to be replaced with absolute URLs.
-
Without additional tips/forewords, pages like Codex can be misleading or awkward.
-
MdBook does not natively support highlighting typst code blocks. The plugin mdbook-typst-highlight hasn’t been updated for two years and is incompatible with the latest mdBook.
I submitted a PR to mdbook-typst-highlight. Coincidentally, another person submitted a similar PR on the same day. I can barely believe it’s true!
-
…
Considering the complexity and the nature of this project, I asked to move the repo under typst-community: GitHub - typst-community/extra-docs: An unofficial collection of extra official documentations for Typst.
Hope the website Typst Extra Docs is helpful and lives long!
(or perhaps I should hope that it will be replaced by the official docs soon)