How to use
This is the path from installing nuckty and your first build to your own extensions.
Where to start
- Start — installation and a first site in five steps.
Concepts
The key concepts of nuckty:
- Data model: BEMJSON — a typed tree of nodes, shared by content, page layout, and the page wrapper.
- nu templates — the
block()(...)syntax, modes, specificity. How a block becomes HTML. - Sitemap: sitemap.yml — one tree defines URLs, titles, page templates, and navigation.
- Build pipeline — phases, named stages, and hooks; how to change the build with code.
- Targets and hreflang — one repository, several sites, language selection.
- External repositories — content from separate repositories.
Content
- Markdown — the same engine turns CommonMark into a tree of blocks. Anchors, links, typography.
Structure and extensions
- Blocks — how to write
.nu.ts, declare dependencies, and manage levels. - Extensions — five types:
pipeline,markdown,block,command,document. A single entry point,register(env).
How to read
Start with the starter project: you will build and edit your first page there. Then explore the data model, templates and sitemap to extend your site.
If you are experienced, jump straight to the concept you need. And if you are curious why things are done this way, see the "Why this way" section.