Riebeckite とは
Riebeckite は、Markdown や Obsidian のノートを Web サイトとして公開するためのオープンソースフレームワークです。
content/ に Markdown を置いてビルドすると、静的なファイルとして出力されます。Plugin で検索や図表、多言語化などの機能を足し、Theme で見た目を選べます。
Riebeckite 本体をクローンする必要はありません。create-riebeckite がサイトのファイル一式を生成します。
content/builddist/
Riebeckite を選ぶ理由
コンテンツ、機能、見た目をそれぞれ独立して扱えます。
Markdown がそのまま
content/ の Markdown をそのまま公開できます。専用の記法を覚え直す必要はありません。
Obsidian Vault を接続
既存の Obsidian Vault を content source として使い、公開するノートだけを選べます。
Plugin で機能追加
検索、図表、埋め込み、多言語化などを Plugin として追加できます。不要なものは入れません。
Theme で見た目を変更
Theme を切り替えても、コンテンツや Plugin の機能はそのままです。
多言語サイト
日本語と英語など複数言語のページを扱えます。それぞれに canonical と hreflang が出力されます。
公開範囲を制御
draft や private、未公開のノートを公開サイトに含めずに管理できます。
作れるもの
同じ仕組みで、目的の違うサイトを作れます。
拡張する
必要な機能と見た目を選べます。
このサイトも Riebeckite 製です
riebeckite.dev 自身が Riebeckite で動いており、次の機能を使っています。
はじめかた
create-riebeckite から新しいサイトを作成します。
サイトを作成
npx create-riebeckiteMarkdown を書く
content/ にノートを追加し、公開するページに publish: true を付けます。
ローカルで確認
npm exec riebeckite dev でブラウザから確認します。ビルドして公開
npm exec riebeckite build で dist/ を出力し、そのままデプロイできます。