Introduction

Welcome to the documentation for Haita 0.3.0 (hǎi tǎ, Mandarin Pinyin, lit. Sea Otter).

PDF Ready!

Info 1

The documentation is also available as a PDF.

It’s not ready yet!

Warning 2

Haita is a decent choice for organizing long, comprehensive documentation. But just like Typst, Haita is an unfinished project, and is (currently) not a serious tool.

Figure 1: How Haita Works

Writing documentation is a lame task. It is even more boring and frustrating when you have to setup toolchains and environments and debug for hours to make sure that they build correctly, only to find that the current tools cannot plot your diagrams, or the PDF generation is missing fonts and takes hours to build. So here’s Haita. A simple tool that has a single requirement: Typst. Here are some features:

Pure Typst workflow
Features inherited from Typst:
- Simple yet expressive Typst syntax helping you focussing on your content
- Native syntax highlighting
- Native MathML output
- Fast compliation
- Native support for watch and serve
- PDF and HTML generation from the same source ¹
- HTML minification.
Minimal client side JS by default (for copying code). No JS required for math blocks. Site fully usable and navigatable without JS.
Good SEO, including generating preview images for links.
Semantic output, and
Minimal setup

𝑊 = \frac{Ψ^{' 2} 𝑎 𝑏}{2 𝜇_{0}} [𝜇^{2} + \sum_{𝑚, 𝑛} (\frac{𝑎_{𝑚 𝑛}^{2}}{4} (\frac{𝑚^{2} 𝑛^{2}}{𝑎^{2}} + \frac{𝑛^{2} 𝜋^{2}}{𝑏^{2}} + 𝜇^{2}) + \frac{8 𝑎_{𝑚 𝑛} 𝜇^{2}}{𝜋^{2} 𝑚 𝑛})]

Listing 1: A math formula example (source). Hover on the equation to reveal the copy button!

𝑓 (𝑥) = \int_{\infty}^{\infty} \hat{𝑓} (𝜉) 𝑒^{2 𝜋 𝑖 𝜉 𝑥} d 𝜉

Listing 2: See how it renders with Typst + MathML (source)

The default theme, New Hamber, also supports dark mode.

You can make a new project in Typst using Haita, set it to bundle export, and Haita would generate a site for you. You don’t need to worry about setting up the toolchain – Typst is the only tool required.

An Unfinished Project

Haita is still missing some features, specifically:

Internationalization support
Built-in search functions

Pagefind Integration

Tip 3

You can integrate Pagefind manually. See this page for details.

However, if you want pure Typst documentation, ease of use, and/or MathML formulae, you might want to give it a try. If you want stability and extremely easy syntax, then maybe you should consider mdBook. If you have any issues, please feel free to open a ticket on GitHub. If you would like to contribute, please open a pull request.

Licensing

The source and the documentation are available under Apache License v2.0.

Tracking

Info 4

This site uses Umami to track visitor status. It stores no cookies and does not collect personal data. All data collected are anonymous, and you can disable tracking for this site following this guide.

PDF generation only works when using --foramt pdf and does not work with --format bundle. See https://github.com/typst/typst/issues/8309 for details. ↗