Menu
NavigateNib

Static by default. Interactive by choice.

Nibframework docs
DocumentationFramework guide

Nib documentation

Nib turns React, Markdown, and typed data into complete static pages. Start with a route, add browser JavaScript only where interaction needs it, then deploy dist/client to any static host.

Choose a guide

  1. Getting started — scaffold a site and publish your first route.
  2. Pages and routes — turn folders into URLs and page metadata.
  3. Markdown and layouts — write content inside reusable TSX layouts.
  4. Data pages and collections — validate data, generate routes, and build indexes.
  5. Image optimization — generate responsive local images at build time.
  6. Plugin content and routing — add formats, feeds, redirects, and virtual routes.
  7. Client enhancements — enhance existing DOM or hydrate one React island.
  8. GitHub Pages — deploy the static output with the correct base path.

Pick the lightest building block

Building block Use it for Browser JavaScript
TSX page Typed, custom static markup None by default
Markdown page Articles, guides, and documentation None by default
Data page YAML, CSV, or another configured format None by default
Client enhancement Scoped events and DOM state Only on marked routes
React island Local React state, effects, and hooks Only on island routes

Build loop

  1. Configure framework options in nib.config.ts.
  2. Add src/pages/<route>/page.tsx, page.md, or a configured data source.
  3. Add src/enhancements/<id>/index.client.ts for scoped DOM work or src/islands/<id>.tsx for local React state.
  4. Run the project’s typecheck and nib build.
  5. Preview or deploy dist/client.

Know the boundary

Nib does not provide runtime routes, runtime data loaders, server actions, whole-page hydration, or inline JSX in Markdown. Content and links remain ordinary static HTML.

Maintaining Nib? Read Releases, the architecture reference, or the client enhancement design record.