Riebeckite ドキュメント

Riebeckite は、Markdown や Obsidian のノートから公開サイトを作るためのフレームワークです。

Markdown を content/ に置くだけのシンプルなサイトから、プラグイン、テーマ、多言語化、外部の Obsidian Vault を使うサイトまで構築できます。

初めて使う場合は、Riebeckite のリポジトリをクローンする必要はありません。

create-riebeckite から新しいサイトを作成します。

はじめる

基本的な流れは次のとおりです。

flowchart LR
    Create["サイトを作る"]
    Content["Markdownを書く"]
    Dev["ブラウザで確認"]
    Build["ビルド"]
    Deploy["デプロイ"]
 
    Create --> Content
    Content --> Dev
    Dev --> Build
    Build --> Deploy

まず クイックスタート から始めてください。

順番に進めたい場合は、

1. クイックスタート
2. インストール
3. 最初の記事
4. プリセット
5. デプロイ

の順で読めます。

全章の一覧は ドキュメント索引 にあります。

基本的な使い方

サイトを作成したら、基本的には次の流れで使います。

create-riebeckite
      ↓
content/ に Markdown を書く
      ↓
riebeckite dev
      ↓
ブラウザで確認
      ↓
riebeckite build
      ↓
deploy

普段サイトを作るだけなら、Riebeckite 本体の内部構造を理解する必要はありません。

何をしたいですか？

目的に近いページから読めます。

ドキュメントの構成

Riebeckite のドキュメントは、目的ごとに分かれています。

flowchart TD
    Docs["Riebeckite Docs"]
 
    Docs --> Getting["Getting Started<br/>使い始める"]
    Docs --> Guides["Guides<br/>具体的な作業"]
    Docs --> Plugins["Plugins<br/>機能を追加する"]
    Docs --> Themes["Themes<br/>見た目を選ぶ"]
    Docs --> Reference["Reference<br/>設定・CLI・API"]
    Docs --> Framework["Framework<br/>内部構造"]
 
    Framework --> Development["Development<br/>本体開発"]

Getting Started

初めて Riebeckite を使う人向けのページです。

サイトの作成から最初の記事、プリセット、デプロイまでを扱います。

Guides

具体的な目的を達成するための手順です。

たとえば、

• Obsidian Vault を使う
• コンテンツリポジトリを分離する
• 多言語化する
• Riebeckite をアップグレードする
• 特定の環境へデプロイする

といった作業を扱います。

プラグイン

Riebeckite に機能を追加するプラグインを探すためのページです。

記事表示、検索、グラフ、Mermaid、Excalidraw など、必要な機能に応じてプラグインを追加できます。

テーマ

サイトの見た目を変更するテーマを探すためのページです。

テーマを変更しても、コンテンツやプラグインの機能そのものは変わりません。

リファレンス

設定値、CLI コマンド、Public API を調べるための資料です。

「この設定は何を意味するのか」「この API は何を提供するのか」を確認したいときに利用します。

フレームワーク

Riebeckite の内部構造を理解したい人向けです。

コンテンツシステム、プラグインシステム、テーマシステム、ビルドシステム、HonoX 連携などを説明します。

通常のサイト利用では読む必要はありません。

サイトを作る人と、本体を開発する人

Riebeckite には大きく2つの使い方があります。

flowchart TD
    User{"あなたの目的"}
 
    User -->|"Riebeckiteでサイトを作る"| Site["create-riebeckite"]
    User -->|"Riebeckite自体を開発する"| Framework["Riebeckiteリポジトリ"]
 
    Site --> Getting["Getting Started / Guides"]
    Framework --> Dev["フレームワーク開発"]

サイトを作る場合

Riebeckite のリポジトリはクローンしません。

create-riebeckite から始めます。

create-riebeckite
      ↓
生成されたサイト
      ↓
content/
      ↓
dev / build
      ↓
deploy

普段利用するのは、生成されたサイト側です。

Riebeckite 本体を開発する場合

Riebeckite 自体へ変更を加える場合だけ、リポジトリをクローンします。

この場合は、

• モノレポ
• ルートの pnpm コマンド
• packages/*
• apps/web
• フレームワークテスト
• 外部サイト E2E

などを扱います。

詳しくは フレームワーク開発 を参照してください。

apps/web は Riebeckite のドキュメント兼参照アプリです。一般ユーザーがサイトを作るためのテンプレートではありません。

迷ったら

どこを読めばよいか分からない場合は、次の基準で選べます。

flowchart TD
    Start["何をしたい？"]
 
    Start --> First{"初めて使う？"}
    First -->|Yes| Getting["Getting Started"]
    First -->|No| Task{"具体的な作業をしたい？"}
 
    Task -->|Yes| Guides["Guides"]
    Task -->|No| API{"設定・CLI・APIを調べたい？"}
 
    API -->|Yes| Reference["Reference"]
    API -->|No| Internal{"内部の仕組みを知りたい？"}
 
    Internal -->|Yes| Framework["Framework"]
    Internal -->|No| Plugins["Plugins / Themes"]

簡単に分けると、

初めて使う
  → Getting Started
 
具体的な作業をする
  → Guides
 
機能や見た目を追加する
  → Plugins / Themes
 
設定・CLI・APIを調べる
  → Reference
 
内部構造を理解する
  → Framework
 
Riebeckite本体を変更する
  → Framework Development

です。

Coding Agent 向けの短い開発ルールは agents に分けています。