Small surface. Deep documentation.

From installation to deployment, read not just how each decision is used but why it exists.

Getting started

01 Getting started Installation, your first route, your first island, the directory layout and the CLI. Read chapter 02 Architecture The decisions, their reasoning, and the middleware order that is treated as a contract. Read chapter

Building pages

03 Routing Route modules, the controller contract and how load order is decided. Read chapter 04 Rendering and templates Layout, components, helpers and the metadata schema. Read chapter 05 Islands The island contract, hydration strategies, shared state and DOM helpers. Read chapter

Performance

06 Caching TTLs, stale-while-revalidate, cache keys and prewarming. Read chapter 07 Build The build pipeline, the manifest, Tailwind sources and the icon sprite. Read chapter

Reference

08 Configuration The complete configuration reference, field by field. Read chapter 09 Dev tools The development flow, the overlay, the report page and the dev gate. Read chapter 10 Deployment Production, Docker, reverse proxies and health checks. Read chapter 11 Migration Moving from Next.js: the mapping table and a staged plan. Read chapter 12 dashboards Read chapter

run the examples

npm --prefix examples/marketing install
npm --prefix examples/marketing run dev

Three examples in the repository

The minimal example is the smallest thing that runs, the blog example touches every surface of the framework, and the marketing example is the page you are reading.

With the server running, the smoke script verifies that every endpoint answers as expected.