Heine documentation
Heine's documentation has complementary layers. Choose the one that matches what you need now.
| Need | Start here |
|---|---|
| Build a first working site | README: First site |
| Learn how the pieces compose | Tutorial |
| Understand a named Heine concept | Glossary |
| Add one capability to an existing site | The focused guides below |
| Check an exact option, field, template value, or function | Reference |
Recommended reading path
The README builds the smallest possible site. Continue with the tutorial to grow it into a multilingual blog with assets, data, listings, pagination, and tags. The tutorial links to a focused guide whenever a feature needs more explanation.
For a complete working site rather than a teaching-sized example, inspect and
build starter-site/. It is a cohesive example, not a
required prerequisite for the guides.
Focused guides
- Internationalization and localization: locale trees, Fluent messages, writing direction, and declared counterparts.
- Collections: page membership and ordering.
- Pagination: generated slices of a collection.
- Taxonomies: tags and other literal term classifications.
- Deployment files: output-root files for hosting and verification services.
- Asset licensing: REUSE-compatible declarations, published license texts, optional complete copied-asset coverage, and template attribution data.
- Development server: local serving, live reload, and byte-range responses for media.
- Drafts: unpublished pages and complete local previews.
- Sitemaps: canonical discovery documents generated from rendered output.
- Atom feeds: locale-local collection syndication feeds.
- Search indexes: locale-local JSON documents for a site-owned browser search experience.
- Table of contents: page-owned Markdown heading navigation.
- Margin footnotes: checked local presentation of ordinary Markdown footnotes.
- Series: checked page-local ordered reading sequences.
Reference material
The reference is the complete current contract. It lists every authored configuration field and page field, along with template values, functions, filters, defaults, and constraints. It intentionally does not repeat the tutorials and examples from the guides.
The glossary defines Heine's public vocabulary. Guides explain terms in context on first use; use the glossary when returning to a term later.
The roadmap records the next deliberately scoped capabilities and the few open questions that need a concrete design before implementation.