Color mode

Framework

Framework documentation is for people who want to understand or develop Riebeckite itself. If you only want to build a site, start with Getting Started and use Reference when you need exact fields or commands.

Read by responsibility

I want to understand… Page
Package ownership and dependency direction Architecture
How Markdown and assets become pages Content system
How plugins are resolved and run Plugin system
How plugins provide standalone pages Page system
How themes interact with CSS and plugin output Theme system
Incremental builds, build state, and plugin cache Build system
How plugins declare build dependencies Build dependency contract
The HonoX/Vite adapter boundary HonoX integration
Diagnostics and Doctor Diagnostics
Read-only inspection commands Inspector
Logger, Tracer, and Profiler Observability
Test layout and golden files Testing
The monorepo development workflow Development

Responsibility boundaries

  • Core owns content-processing contracts and orchestration. It does not depend on HonoX, Vite, a specific plugin, or a theme.
  • Plugins extend Markdown, HTML, metadata, assets, client behavior, endpoints, SEO, diagnostics, and graph behavior.
  • Themes own appearance: tokens, CSS, stable-hook styling, and safe theme attributes.
  • Integrations connect Core to a web framework and bundler. The current supported adapter is HonoX/Vite.
  • Applications hold site-specific routes, components, and islands.
  • CLI is build-time tooling. Runtime Cloudflare Workers code must not access build state or filesystem caches.

For repository development

The Riebeckite monorepo clone workflow is intentionally here, not in Getting Started. Use it only when you are changing Riebeckite itself: Development.

History

1 changesCollapseExpand
1 + ---
2 + title: Framework
3 + sidebar:
4 + label: Framework
5 + order: 60
6 + collapsed: true
7 + ---
8 + # Framework
9 +
10 + Framework documentation is for people who want to understand or develop Riebeckite itself. If you only want to build a site, start with [Getting Started](../getting-started/README.en.md) and use [Reference](../reference/README.en.md) when you need exact fields or commands.
11 +
12 + ## Read by responsibility
13 +
14 + | I want to understand… | Page |
15 + | --- | --- |
16 + | Package ownership and dependency direction | [Architecture](./architecture.en.md) |
17 + | How Markdown and assets become pages | [Content system](./content-system.en.md) |
18 + | How plugins are resolved and run | [Plugin system](./plugin-system.en.md) |
19 + | How plugins provide standalone pages | [Page system](./page-system.en.md) |
20 + | How themes interact with CSS and plugin output | [Theme system](./theme-system.en.md) |
21 + | Incremental builds, build state, and plugin cache | [Build system](./build-system.en.md) |
22 + | How plugins declare build dependencies | [Build dependency contract](./build-dependency.en.md) |
23 + | The HonoX/Vite adapter boundary | [HonoX integration](./honox-integration.en.md) |
24 + | Diagnostics and Doctor | [Diagnostics](./diagnostics.en.md) |
25 + | Read-only inspection commands | [Inspector](./inspector.en.md) |
26 + | Logger, Tracer, and Profiler | [Observability](./observability.en.md) |
27 + | Test layout and golden files | [Testing](./testing.en.md) |
28 + | The monorepo development workflow | [Development](./development.en.md) |
29 +
30 + ## Responsibility boundaries
31 +
32 + - **Core** owns content-processing contracts and orchestration. It does not depend on HonoX, Vite, a specific plugin, or a theme.
33 + - **Plugins** extend Markdown, HTML, metadata, assets, client behavior, endpoints, SEO, diagnostics, and graph behavior.
34 + - **Themes** own appearance: tokens, CSS, stable-hook styling, and safe theme attributes.
35 + - **Integrations** connect Core to a web framework and bundler. The current supported adapter is HonoX/Vite.
36 + - **Applications** hold site-specific routes, components, and islands.
37 + - **CLI** is build-time tooling. Runtime Cloudflare Workers code must not access build state or filesystem caches.
38 +
39 + ## For repository development
40 +
41 + The Riebeckite monorepo clone workflow is intentionally here, not in Getting Started. Use it only when you are changing Riebeckite itself: [Development](./development.en.md).
42 +
43 +