Heine documentation

Start with the smallest working site, then add the pieces your site needs. The First site page shows how to create one page and one template. The tutorial continues from that point and builds a multilingual blog with content, assets, data, listings, pagination, and tags.

When you return with a specific task, use the guides below. The reference gives the exact contract for every setting and template value, while the glossary explains Heine terms.

For a complete working site rather than a teaching-sized example, inspect and build starter-site/. It shows several features working together, but you do not need it before using the guides. Its source tour maps a feature to the rendered example, its authored files, and the relevant guide.

Shape a site

• Internationalization and localization: add languages, translated text, and declared counterparts.
• Collections: group and order pages that belong together.
• Pagination: divide a collection into generated listings.
• Taxonomies: classify pages with tags or other literal terms.
• Series: create checked reading sequences between pages.
• Drafts: keep work out of publication while previewing the full site locally.

Write and present pages

• Declared content: choose ordinary Markdown, named prose segments, structured data, or several page inputs.
• Table of contents: add navigation from a page's Markdown headings.
• Margin footnotes: place ordinary Markdown footnotes beside their references when the layout allows it.
• Markdown block components: wrap authored Markdown in a site or kit component without templating the whole document.
• Color-scheme Markdown pictures: use light and dark variants of one authored image.
• Word counts and reading time: show deterministic word counts and opt-in, locale-specific reading-time estimates.
• Localized numbers: format numbers consistently in Tera and Fluent messages.
• Kits: install a checked presentation package and adapt its public templates from the site root.

Publish and help readers find it

• Deployment files: publish output-root files for hosting and verification services.
• Absolute URLs: give pages and resources canonical addresses from a configured origin.
• Sitemaps: generate discovery documents from rendered output.
• Atom feeds: publish locale-local feeds from a collection.
• Search indexes: build JSON documents for a site-owned browser search experience.

Operate a site

• Development server: local serving, live reload, and byte-range responses for media.
• Published-artifact licensing: REUSE-compatible declarations, published license texts, optional complete coverage for copied assets and renderer resources, and template attribution data.
• Renderer adapters: configure checked replacements produced by external tools.
• Renderer examples: install Typst or KaTeX and build diagrams or accessible mathematics locally.

Architecture and project decisions

The architecture overview explains how a full build moves from authored files to published output. If you want to understand a trade-off or contribute, the design records explain why features have their current boundaries and preserve investigations for later proposals. The roadmap records planned work and open questions.

The changelog records user-visible changes and migrations, including work that has not reached a release yet.