Color mode
Riebeckite

Open source · Apache-2.0 · TypeScript

Markdown is where your site begins.

Build a static site from Markdown or an Obsidian vault, while keeping routes, components, and styles in an application you own.

Create a project

sh
npx create-riebeckite
content/guides/development-setup.mdpublished

Team notes / Development

Set up a development environment for new team members.

Keep the Node.js version, required environment variables, and local startup steps in one place. Update this page when they change.

See how content is organized →

See the pieces of a published site together.

Start from Markdown, then choose the navigation, discovery tools, theme, and routes that make the site yours. These are the same surfaces available to a generated project.

team-handbook.examplepreview

Development / Releases

This week's release checklist

Review the changes, test in staging, and complete the checks after publishing.

Write the note. Publish the page.

The same Riebeckite pipeline that builds a site parses frontmatter, Markdown, and Obsidian WikiLinks here.

Markdown source

---
title: Hello
---

## Hello

My **first** note.

[Getting started](/docs/getting-started)

Published page

Add the feature your site needs.

Install a package, register it in the configuration, and decide where its components belong in your routes.

sh
npm install @riebeckite/plugin-search
ts
import { search } from "@riebeckite/plugin-search";
 
export default defineConfig({
  plugins: [search()],
});

This example adds site search. Plugins can also add transforms, renderers, standalone pages, browser behavior, endpoints, SEO, and diagnostics. Themes supply tokens and styles without deciding the application structure.

Find a Plugin by what you want to publish.

Start with a site need rather than a package name. Each guide covers setup and the pieces you add to your routes.

Keep content, interface, and settings separate.

Generated projects use ordinary files, so each change has an obvious home. Writing stays separate from the interface around it, while one configuration file describes the site you are assembling.

Content
Keep Markdown in content/ so notes can grow and move without changing the application.
Interface
Use app/routes/ and app/components/ for the pages and UI your readers use.
Settings
Choose plugins, themes, and content sources in riebeckite.config.ts.
See the project setup
app/
  routes/
  components/
content/
riebeckite.config.ts

Keep the publishing path short.

  1. CreateGenerate the project.
  2. WriteAdd Markdown to your content source.
  3. ReviewBuild and inspect the output.
  4. PublishDeploy the generated dist/.

Publish the build you reviewed.

Build output is written to dist/. The deployment guide covers local Cloudflare Workers publishing, GitHub Actions, and separate content repositories.