Introduction

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

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 ¹ PDF generation is currently suspended. See https://github.com/typst/typst/issues/8309 for details.
  • HTML minification.
• No client side JS by default, including when using Math.
• Good SEO
• Semantic output, and
• Minimal setup

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 a decent choice for organizing long, comprehensive documentation. But just like Typst, Haita is an unfinished project, and is (currently) not a serious tool. Specifically, it’s missing these features:

• Internationalization support
• Built-in search functions

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.

Installation

You don’t need to install anything! Just import the library then write docs!

Licensing

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