Color mode

Project Structure

A generated Riebeckite site is a small static-site project. You can keep content and site code together, or split them. The three supported layouts are:

Layout Content Site code Use when
Integrated content/ in the site repository Same repository One person or one repository owns everything
Separate directories vault/ next to site/ Same repository You want an Obsidian vault and the site code clearly separated
Separate repositories Another repository Its own repository Writers update content without touching site code

Integrated files

text
my-site/
├── content/
│   ├── index.md
│   ├── notes/
│   └── assets/
├── app/
├── public/
├── riebeckite.config.ts
├── package.json
├── wrangler.jsonc
└── .github/workflows/publish.yml

This tree assumes a deployment option such as --github-actions or --cloudflare-workers. With the default Not now, wrangler.jsonc and .github/workflows/publish.yml are not generated.

  • content/ is the default content directory.
  • app/ contains the generated HonoX app.
  • public/ contains files served as-is, such as a favicon.
  • riebeckite.config.ts sets site, content.directory, the theme, and plugins.
  • wrangler.jsonc describes the Cloudflare Worker and its custom domain.
  • dist/ is generated by npm exec riebeckite build and is not committed.

Separate directories

text
my-project/
├── vault/
│   ├── index.md
│   ├── notes/
│   └── assets/
├── site/
│   ├── app/
│   ├── riebeckite.config.ts
│   ├── package.json
│   └── wrangler.jsonc
└── .github/workflows/publish.yml

Only the site directory has package.json. Its configuration points at the vault:

ts
export default defineConfig({
  content: { directory: "../vault" },
  // ...
});

Run commands from site/. The workflow must set working-directory: site and include the vault in its push paths.

Separate repositories

text
my-site/                 my-vault/
├── app/                 ├── index.md
├── riebeckite.config.ts ├── notes/
├── package.json         └── assets/
└── .github/workflows/

The site workflow checks the vault out into content/ before building. The vault workflow sends repository_dispatch to the site workflow after a push.

Next

Powered by Riebeckite

Local Graph

Nearby Notes