Riebeckite
Menu
Color mode

Framework

この章では、Riebeckite 自体がどのように動いているかを説明します。

対象となるのは、

  • Riebeckite の内部構造を理解したい人
  • Plugin や Theme の仕組みを詳しく知りたい人
  • Riebeckite 本体を開発・変更したい人

です。

Riebeckite を使って自分のサイトを作りたいだけなら、この章を最初から読む必要はありません。Getting Started から始めてください。

Diagram source
text
flowchart LR
    Start["Riebeckiteを使いたい"]
 
    Start --> Q{"何をしたい？"}
 
    Q -->|"サイトを作る"| GettingStarted["Getting Started"]
    Q -->|"仕組みを理解する"| Framework["Framework"]
    Q -->|"Riebeckite本体を開発する"| Framework
 
    Framework --> Architecture["Architecture"]
    Framework --> Development["Development"]

どこから読む？

目的に合わせて、必要なページだけ読めます。

知りたいこと ページ
Riebeckite 全体の構造 Architecture
Markdown や Content がどう処理されるか Content System
Plugin がどう動くか Plugin System
Plugin が独立したページを提供する仕組み Page System
Theme が見た目を変更する仕組み Theme System
Build と Incremental Build の仕組み Build System
Plugin が build dependency を宣言する仕組み Build Dependency Contract
Riebeckite と HonoX / Vite の接続 HonoX Integration
設定や Content の問題を調べる Diagnostics
解決済みの設定や状態を確認する Inspector
Log / Trace / Performance を調べる Observability
Riebeckite のテストを書く・実行する Testing
Riebeckite 本体を開発する Development

最初に内部構造を理解したい場合

まず Architecture を読むのがおすすめです。

Riebeckite は大きく、

Diagram source
text
flowchart BT
    App["Application"]
    Integration["Integration"]
    Plugin["Plugin"]
    Theme["Theme"]
    Core["Core"]
 
    App --> Integration
    Integration --> Core
    Plugin --> Core
    Theme --> Core

という責務に分かれています。

Architecture を読んだあと、変更したい領域に応じて Content System、Plugin System、Theme System などへ進むと理解しやすくなります。

Riebeckite 本体を開発する場合

Riebeckite repository を clone して Framework 自体を変更する場合は、Development を参照してください。

Development では、

  • monorepo の clone
  • pnpm install
  • root の pnpm コマンド
  • packages/* の構成
  • apps/web
  • Package ごとのテスト
  • Scaffold / External Site の検証

などを扱います。

text
Riebeckite repository 自体を開発する
    → Framework / Development
 
Riebeckite を使ってサイトを作る
    → Getting Started

apps/web は Riebeckite の Documentation / Reference Application です。

一般ユーザーが Riebeckite を使うために apps/web をコピーしたり、Riebeckite monorepo を clone したりする必要はありません。

この章の境界

Framework 章では、Riebeckite の内部設計と Framework 開発を扱います。

一方、

  • Site の作成
  • Content の追加
  • Plugin / Theme の設定
  • Deploy

といった通常の利用方法は Getting Started や Guides で説明します。

この境界を分けることで、Riebeckite を使うだけの人が Framework 内部の知識を覚えなくてもサイトを作れるようにしています。

History

1 changesCollapseExpand
1 + ---
2 + title: Framework
3 + sidebar:
4 + label: Framework
5 + order: 60
6 + collapsed: true
7 + ---
8 + # Framework
9 +
10 + この章では、**Riebeckite 自体がどのように動いているか**を説明します。
11 +
12 + 対象となるのは、
13 +
14 + - Riebeckite の内部構造を理解したい人
15 + - Plugin や Theme の仕組みを詳しく知りたい人
16 + - Riebeckite 本体を開発・変更したい人
17 +
18 + です。
19 +
20 + Riebeckite を使って自分のサイトを作りたいだけなら、この章を最初から読む必要はありません。[Getting Started](../getting-started/README.ja.md) から始めてください。
21 +
22 + ```mermaid
23 + flowchart LR
24 + Start["Riebeckiteを使いたい"]
25 +
26 + Start --> Q{"何をしたい？"}
27 +
28 + Q -->|"サイトを作る"| GettingStarted["Getting Started"]
29 + Q -->|"仕組みを理解する"| Framework["Framework"]
30 + Q -->|"Riebeckite本体を開発する"| Framework
31 +
32 + Framework --> Architecture["Architecture"]
33 + Framework --> Development["Development"]
34 + ```
35 +
36 + ## どこから読む？
37 +
38 + 目的に合わせて、必要なページだけ読めます。
39 +
40 + | 知りたいこと | ページ |
41 + | --- | --- |
42 + | Riebeckite 全体の構造 | [Architecture](./architecture.ja.md) |
43 + | Markdown や Content がどう処理されるか | [Content System](./content-system.ja.md) |
44 + | Plugin がどう動くか | [Plugin System](./plugin-system.ja.md) |
45 + | Plugin が独立したページを提供する仕組み | [Page System](./page-system.ja.md) |
46 + | Theme が見た目を変更する仕組み | [Theme System](./theme-system.ja.md) |
47 + | Build と Incremental Build の仕組み | [Build System](./build-system.ja.md) |
48 + | Plugin が build dependency を宣言する仕組み | [Build Dependency Contract](./build-dependency.ja.md) |
49 + | Riebeckite と HonoX / Vite の接続 | [HonoX Integration](./honox-integration.ja.md) |
50 + | 設定や Content の問題を調べる | [Diagnostics](./diagnostics.ja.md) |
51 + | 解決済みの設定や状態を確認する | [Inspector](./inspector.ja.md) |
52 + | Log / Trace / Performance を調べる | [Observability](./observability.ja.md) |
53 + | Riebeckite のテストを書く・実行する | [Testing](./testing.ja.md) |
54 + | Riebeckite 本体を開発する | [Development](./development.ja.md) |
55 +
56 + ## 最初に内部構造を理解したい場合
57 +
58 + まず [Architecture](./architecture.ja.md) を読むのがおすすめです。
59 +
60 + Riebeckite は大きく、
61 +
62 + ```mermaid
63 + flowchart BT
64 + App["Application"]
65 + Integration["Integration"]
66 + Plugin["Plugin"]
67 + Theme["Theme"]
68 + Core["Core"]
69 +
70 + App --> Integration
71 + Integration --> Core
72 + Plugin --> Core
73 + Theme --> Core
74 + ```
75 +
76 + という責務に分かれています。
77 +
78 + Architecture を読んだあと、変更したい領域に応じて Content System、Plugin System、Theme System などへ進むと理解しやすくなります。
79 +
80 + ## Riebeckite 本体を開発する場合
81 +
82 + Riebeckite repository を clone して Framework 自体を変更する場合は、[Development](./development.ja.md) を参照してください。
83 +
84 + Development では、
85 +
86 + - monorepo の clone
87 + - `pnpm install`
88 + - root の `pnpm` コマンド
89 + - `packages/*` の構成
90 + - `apps/web`
91 + - Package ごとのテスト
92 + - Scaffold / External Site の検証
93 +
94 + などを扱います。
95 +
96 + ```text
97 + Riebeckite repository 自体を開発する
98 + → Framework / Development
99 +
100 + Riebeckite を使ってサイトを作る
101 + → Getting Started
102 + ```
103 +
104 + `apps/web` は Riebeckite の Documentation / Reference Application です。
105 +
106 + 一般ユーザーが Riebeckite を使うために `apps/web` をコピーしたり、Riebeckite monorepo を clone したりする必要はありません。
107 +
108 + ## この章の境界
109 +
110 + Framework 章では、Riebeckite の**内部設計と Framework 開発**を扱います。
111 +
112 + 一方、
113 +
114 + - Site の作成
115 + - Content の追加
116 + - Plugin / Theme の設定
117 + - Deploy
118 +
119 + といった通常の利用方法は [Getting Started](../getting-started/README.ja.md) や Guides で説明します。
120 +
121 + この境界を分けることで、Riebeckite を使うだけの人が Framework 内部の知識を覚えなくてもサイトを作れるようにしています。
122 +