Haita

Checkout the online user guide to start using Haita! The guide also uses Haita.

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

Installation

Installing Haita's dependencies is incredibly simple! You only need the Typst compiler. Typst will automatically fetch the required packages when compiling the documents.

Example

#!/usr/bin/env -S typst compile --features bundle,html --format bundle
// The line above compiles the documentation to an HTML bundle.
// Additionally, you can watch the file using this command:
//
// $ typst watch --features bundle,html --format bundle main.typ
//
// You can also build and watch the PDF using the follow commands:
//
// $ typst compile --features bundle,html --format pdf main.typ
// $ typst watch --features bundle,html --format pdf main.typ
//
#import "@preview/haita:0.3.0": * // Always import the package!
#book(
  // Where the site will be deployed. Optional: it is only used for the
  // SEO metadata, everything inside the site is linked relatively.
  // base-url: "https://username.github.io/haita",

  // This sets your html renderer. You can customize the HTML renderer
  // using `html-renderer.with(...)`, or write your own!
  html-renderer: new-hamber.html-renderer,
  // Your document's contents
  tree: (
    // You can add arbitrary content. The content will be displayed
    // in the summary, but will not generate html pages.
    [= Welcome!],
    // This will create index.html. The content of the
    // chapter will be from `index.typ`
    chapter("index", content: include "index.typ"),
    // This will create doc/tutorial.html. In this case,
    // the content of the chapter is not explicitly stated, so it
    // looks into ./doc/tutorial.typ in the current workspace.
    chapter(
      "doc/tutorial",
      content: include "tutorial.typ",
      // you can generate chapters procedurally
      children: range(1, 6).map(num => chapter("doc/" + str(num), content: [
        #title[Chapter #num]
        This page is generated procedurally!
      ])),
    ),
    // You can add dividers, which will separate content in the summary.
    divider(),
    // Alternatively, if you would like to directly include the content
    // without creating a new file, you can write it like this:
    chapter("my-page", content: [
      #title[My Page]
      = Heading 1
      = Heading 2
      foo bar baz
    ]),
    // you can also add arbitrary content
    [Made with Haita.],
    // you can add more chapters afterwards.
  ),
)

Licensing

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

Footnotes

1. 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. ↩