Riebeckite
Menu
Color mode

Framework Development

This page is for people developing Riebeckite itself: core, CLI, HonoX integration, official plugins, official themes, templates, or the reference app. It is intentionally separate from Getting Started. Users who only want to publish a site should use create-riebeckite instead of cloning this monorepo.

Clone and install

bash
git clone https://github.com/rerurate/riebeckite.git
cd riebeckite
pnpm install
pnpm build

Common commands

bash
pnpm dev
pnpm build
pnpm check
pnpm check:docs
pnpm check:scaffold
pnpm test

Use targeted commands when possible:

  • pnpm check:docs validates Markdown links and docs structure.
  • pnpm check:scaffold validates generated scaffold output.
  • pnpm typecheck checks packages.
  • pnpm --filter <package> test runs a package test when available.

Repository layout

Path Purpose
packages/core public config, content, pipeline, plugin, theme, diagnostics, observability APIs
packages/cli riebeckite command
packages/integrations/honox HonoX integration and scaffold generator
packages/create-riebeckite public site scaffolding entrypoint
packages/plugins/* official plugins
packages/themes/* official themes
apps/web official documentation app and framework-development reference application
docs/ documentation source read by the official docs app
templates/analytics-cloudflare Analytics Worker deployment templates

Boundaries

  • Core must not depend on app, plugin package internals, or framework-specific reverse dependencies.
  • External plugins and themes must use public exports, not src/** imports.
  • General-user docs must not require monorepo setup.
  • Generated scaffolds must remain self-contained sites.

See Architecture, Testing, CLI, and HonoX Integration.

History

1 changesCollapseExpand
1 + # Framework Development
2 +
3 + This page is for people developing Riebeckite itself: core, CLI, HonoX integration, official plugins, official themes, templates, or the reference app. It is intentionally separate from [Getting Started](../getting-started/README.en.md). Users who only want to publish a site should use `create-riebeckite` instead of cloning this monorepo.
4 +
5 + ## Clone and install
6 +
7 + ```bash
8 + git clone https://github.com/rerurate/riebeckite.git
9 + cd riebeckite
10 + pnpm install
11 + pnpm build
12 + ```
13 +
14 + ## Common commands
15 +
16 + ```bash
17 + pnpm dev
18 + pnpm build
19 + pnpm check
20 + pnpm check:docs
21 + pnpm check:scaffold
22 + pnpm test
23 + ```
24 +
25 + Use targeted commands when possible:
26 +
27 + - `pnpm check:docs` validates Markdown links and docs structure.
28 + - `pnpm check:scaffold` validates generated scaffold output.
29 + - `pnpm typecheck` checks packages.
30 + - `pnpm --filter <package> test` runs a package test when available.
31 +
32 + ## Repository layout
33 +
34 + | Path | Purpose |
35 + | --- | --- |
36 + | `packages/core` | public config, content, pipeline, plugin, theme, diagnostics, observability APIs |
37 + | `packages/cli` | `riebeckite` command |
38 + | `packages/integrations/honox` | HonoX integration and scaffold generator |
39 + | `packages/create-riebeckite` | public site scaffolding entrypoint |
40 + | `packages/plugins/*` | official plugins |
41 + | `packages/themes/*` | official themes |
42 + | `apps/web` | official documentation app and framework-development reference application |
43 + | `docs/` | documentation source read by the official docs app |
44 + | `templates/analytics-cloudflare` | Analytics Worker deployment templates |
45 +
46 + ## Boundaries
47 +
48 + - Core must not depend on app, plugin package internals, or framework-specific reverse dependencies.
49 + - External plugins and themes must use public exports, not `src/**` imports.
50 + - General-user docs must not require monorepo setup.
51 + - Generated scaffolds must remain self-contained sites.
52 +
53 + See [Architecture](./architecture.en.md), [Testing](./testing.en.md), [CLI](../reference/cli.en.md), and [HonoX Integration](./honox-integration.en.md).
54 +