Riebeckite
Menu
Color mode

Open source · Apache-2.0

Turn Markdown and Obsidian notes into an extensible website.

Keep your content where it is. Add plugins, choose a theme, and build the site you want.

Get startedGitHub

What is Riebeckite?

Riebeckite is an open-source framework for publishing Markdown and Obsidian notes as a website.

Write Markdown in content/ and build it into static files. Add features like search, diagrams, and localization with plugins, and pick a look with a theme.

You do not clone the Riebeckite repository. create-riebeckite generates the files for a new site.

  1. content/
  2. build
  3. dist/

Why Riebeckite

Content, features, and presentation stay independent.

  1. Your Markdown as-is

    Publish the Markdown in content/ directly. There is no separate syntax to learn.

  2. Connect an Obsidian vault

    Use an existing Obsidian vault as the content source and publish only the notes you choose.

  3. Add plugins

    Search, diagrams, embeds, and localization are available as plugins. Add only what you need.

  4. Change with themes

    Switching a theme leaves your content and plugin features untouched.

  5. Multilingual sites

    Handle pages in more than one language, each with its own canonical and hreflang output.

  6. Control what is public

    Keep draft, private, and unpublished notes out of the published site.

What you can build

One framework, several kinds of site.

Extend it

Choose the features and the look you want.

Plugin

Plugins

Add Markdown processing, diagrams, search, navigation, publishing, and SEO features from the official plugin catalog.

Browse plugins

Theme

Themes

Themes handle presentation only. Choose from the official themes and change it later.

Explore themes

This site is built with Riebeckite

riebeckite.dev runs on Riebeckite itself and uses these features.

See plugins in action

Get started

Create a new site with create-riebeckite.

  1. Create a site

    npx create-riebeckite

  2. Write Markdown

    Add notes to content/ and set publish: true on the pages you want to publish.

  3. Preview locally

    Run npm exec riebeckite dev and open the local URL.

  4. Build and deploy

    Run npm exec riebeckite build to output dist/, then deploy it.

Read Getting Started

Go deeper