#(unfinished/experimental) shiroa + tidy for docs

3 messages · Page 1 of 1 (latest)

novel helm
#

So I wanted to test how well it would work to port one of my packages' manuals to shiroa, to display it as an HTML page, and this is my progress so far:

https://sillyfreak.github.io/typst-bullseye/

for comparison, this is the original (using a permalink for the PDF, but the github pages site may be updated in the future)

This is by no means complete; from a quick look, I can see that

  • footnotes are not shown
  • functions have no signatures (the default Tidy style uses elements not yet supported in HTML support)
  • references to function in Tidy docs don't work, and generally Shiroa's linking is comparatively manual
  • in general, a Tidy style specifically made for HTML would be good

Note that some of this could probably (I didn't test this) be fixed by not using shiroa's --mode static-html. That would render the docs more like a regular PDF export, iiuc.

I don't think I will have time to work on this more in the short term, so I wanted to put this out there in case anyone wants to use this as a starting point 🙂

Here is the diff of the current progress (permalink), and the branch (may change in the future).

Introduction - Bullseye

Bullseye supports you in writing packages and documents that target multiple outputs, i.e. currently (Typst 0.13) "paged" (PDF, image) and "html".

This package consists of two parts: At the foundation, it contains a wrapper around the currently unstable Typst features for target detection and HTML output. Built on top of that are a few helpful ...

naive forge
#

👀

flat skiff