100% Typst HTML documentation

Hey there :wave:,

Just released the 5th version of my package a few weeks ago, with a whole new documentation fully written in Typst. As I’ve not seen many package doing so, I just want to introduce you to the amazing capabilities of Typst compiler that I’ve used for this project.

You can easily check the documentation to get a view of what’s possible.

I really loved the way you can create all the elements you want using #html, or the capability to draw any svg image (circuits in my case). I am also a big fan of the built-in code block highlighter.
However, I missed some very necessary features and I had to make difficult choices to not block my project.

  • Multi-pages HTML export: I did a one-page documentation, which is not very practical.
  • <head> access: currently, it is not possible to customize the head content. It would be very useful, like for adding scripts, css files, fonts, etc. headers, as well as favicons and OG images.

Finally, I know that most people are not used to HTML, CSS or JS, which is why an HTML docs template on Typst Universe would be awesome. Everyone would be just a few lines away from having an online documentation (or even publication/book/website/etc.), without the need to download specific tools (it would be 100% written in Typst). Maybe for a next project…

6 Likes