Setup

Getting started

To develop Riebeckite itself, clone the repository and install the dependencies:

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

You can now develop the packages in the workspace.

Start the development server

pnpm dev

The reference app in website lets you see Riebeckite changes as a real site.

website is not just a demo: it is also the reference application used during framework development to confirm that Core, plugins, themes, and the integration combine correctly.

Repository layout

Riebeckite is a monorepo built on the pnpm workspace.

The top level is split roughly like this:

Diagram source

flowchart TD
    Repo["riebeckite/"]
 
    Repo --> Packages["packages/"]
    Repo --> Website["website/"]
    Repo --> Docs["docs/"]
    Repo --> Templates["templates/"]
 
    Packages --> Core["core<br/>Shared foundation"]
    Packages --> CLI["cli<br/>CLI"]
    Packages --> Integration["integrations/honox<br/>HonoX connection"]
    Packages --> Create["create-riebeckite<br/>Site generation"]
    Packages --> Plugins["plugins/*<br/>Official plugins"]
    Packages --> Themes["themes/*<br/>Official themes"]
 
    Website --> Web["app/<br/>Official docs / reference app"]
    Docs --> DocSource["Documentation source"]
    Templates --> Analytics["analytics-cloudflare<br/>Analytics deployment template"]

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
`website`	official documentation app and framework-development reference application
`docs/`	documentation source read by the official docs app
`templates/analytics-cloudflare`	Analytics Worker deployment templates

For the detailed responsibilities of each package, see Architecture.

Common commands

The commands you use most often during framework development are:

Command	Purpose
`pnpm dev`	Start the development site.
`pnpm build`	Build the workspace.
`pnpm check`	Check the whole repository.
`pnpm test`	Run the tests.
`pnpm typecheck`	Check TypeScript types.
`pnpm check:docs`	Check the documentation.
`pnpm changes:new`	Create a change entry for a user-facing change.
`pnpm changelog`	Regenerate the changelog and release notes pages.
`pnpm check:changes`	Validate change entries and generated files.
`pnpm docs:sync`	Generate Plugin and Theme package READMEs from canonical docs.
`pnpm check:plugin-docs`	Verify Plugin docs and generated READMEs are synchronized.
`pnpm check:theme-docs`	Verify Theme docs and generated READMEs are synchronized.
`pnpm check:scaffold`	Check the generated `starter`, `minimal`, `showcase`, and `empty` presets.

Use targeted commands when possible:

pnpm check:docs validates Markdown links and docs structure.
pnpm check:scaffold validates the starter, minimal, showcase, and empty scaffold output.
pnpm typecheck checks packages.
pnpm --filter <package> test runs a package test when available.

When you change the documentation

pnpm check:docs

This validates Markdown links and the documentation structure. Run it whenever you add, move, or delete documentation.

When you change Plugin or Theme documentation

Plugin / Theme documentation ownership is:

Canonical source:
  docs/docs/plugins/<slug>.md
  docs/docs/plugins/<slug>.ja.md
  docs/docs/themes/<slug>.md
  docs/docs/themes/<slug>.ja.md
 
Generated outputs:
  packages/plugins/<slug>/README.md
  packages/plugins/<slug>/README_ja.md
  packages/themes/<slug>/README.md
  packages/themes/<slug>/README_ja.md

Edit canonical docs only. Never manually edit generated READMEs. After a change, run:

pnpm docs:sync
pnpm check:plugin-docs
pnpm check:theme-docs

When you change the scaffold

pnpm check:scaffold

This validates that the generated starter, minimal, showcase, and empty presets have the correct structure. It checks the generated configuration and files without an install or a build, so it does not cover the other four presets (digital-garden, blog, docs, portfolio). It matters when you change things such as:

the scaffold generator
a preset
a template
the generated package.json
the initial site structure

Check package types

pnpm typecheck

This reports TypeScript type errors.

Test a specific package

When you only want to check the package you changed, you can use --filter:

pnpm --filter <package> test

For example, if you only changed one plugin, you can start from that package's tests instead of running the entire repository test suite.