Riebeckite
Menu
Color mode

Guides

Guides は、「Riebeckite で何をしたいか」から手順を探すための章です。

設定値や API の正確な仕様を確認したい場合は Reference、Riebeckite の内部構造を理解したい場合は Framework を参照してください。

Diagram source
text
flowchart TD
    Q{"何を知りたい？"}
 
    Q -->|"具体的な作業手順"| Guides["Guides"]
    Q -->|"設定・CLI・API"| Reference["Reference"]
    Q -->|"内部の仕組み"| Framework["Framework"]

初めて Riebeckite を使う場合は、Guides より先に Getting Started から始めるのがおすすめです。

コンテンツを作る

記事を書く

Writing Content

Markdown、Frontmatter など、Riebeckite で記事を書くための基本を説明します。

Obsidian Vault を公開する

Obsidian

既存の Obsidian Vault を Riebeckite の Content として利用する方法を説明します。

サイトを構成する

Content と Site を分ける

Content Repositories

Site Application と Markdown Content を別の Repository で管理する構成について説明します。

多言語サイトを作る

Localization

複数言語の Content、URL、言語切り替えなどを扱う方法を説明します。

Analytics を使う

Analytics

Riebeckite Site に Analytics を導入する方法を説明します。

アイコンやロゴを差し替える

サイトのアイコンとロゴ

Site 固有の favicon、ヘッダーのロゴ、リンクプレビュー画像を差し替える方法を説明します。

Site の UI をカスタマイズする

サイトのカスタマイズ

通常の HonoX application として app/ の route、component、island、CSS を編集する方法を説明します。

デプロイする

デプロイ方法を選ぶ場合は、まず Deployment を参照してください。

Diagram source
text
flowchart TD
    Deploy["Siteを公開したい"]
 
    Deploy --> Overview["Deployment"]
 
    Overview --> Workers["Cloudflare Workers"]
    Overview --> Actions["GitHub Actions"]
    Overview --> Separate["Separate Content Repository"]

Cloudflare Workers

Cloudflare Workers

Riebeckite Site を Cloudflare Workers へデプロイする方法を説明します。

GitHub Actions

GitHub Actions

GitHub Actions を使って Build と Deployment を自動化する方法を説明します。

Separate Content Repository

Separate Content Repository

Content と Site が別 Repository にある場合の自動デプロイ構成を説明します。

Riebeckite を更新する

Upgrading

Riebeckite の Package を新しい Version へ更新するときの手順と、変更点の確認方法を説明します。

目的から探す

やりたいこと ページ
Markdown で記事を書く Writing Content
Obsidian Vault を公開する Obsidian
Content と Site を別 Repository にする Content Repositories
多言語 Site にする Localization
Analytics を導入する Analytics
サイトのアイコンやロゴを差し替える サイトのアイコンとロゴ
Site の UI をカスタマイズする サイトのカスタマイズ
Homepage と発見導線を作る 発見導線のレシピ
デプロイ方法を選ぶ Deployment
Cloudflare Workers に公開する Cloudflare Workers
GitHub Actions で自動デプロイする GitHub Actions
Separate Content Repository を自動デプロイする Separate Content Repository
Riebeckite をアップグレードする Upgrading

Guides と他の章の違い

ドキュメントの役割は次のように分かれています。

text
初めてSiteを作る
  → Getting Started
 
やりたい作業の手順を知る
  → Guides
 
Pluginを探す
  → Plugins
 
Themeを探す
  → Themes
 
設定・CLI・APIを調べる
  → Reference
 
内部構造を理解する
  → Framework

Guides では、内部実装を詳しく説明することよりも、目的を達成するために何をすればよいかを中心に説明します。

History

1 changesCollapseExpand
1 + ---
2 + title: Guides
3 + sidebar:
4 + label: Guides
5 + order: 20
6 + ---
7 + # Guides
8 +
9 + Guides は、**「Riebeckite で何をしたいか」から手順を探すための章**です。
10 +
11 + 設定値や API の正確な仕様を確認したい場合は [Reference](../reference/README.md)、Riebeckite の内部構造を理解したい場合は [Framework](../framework/README.md) を参照してください。
12 +
13 + ```mermaid id="d2p74f"
14 + flowchart TD
15 + Q{"何を知りたい？"}
16 +
17 + Q -->|"具体的な作業手順"| Guides["Guides"]
18 + Q -->|"設定・CLI・API"| Reference["Reference"]
19 + Q -->|"内部の仕組み"| Framework["Framework"]
20 + ```
21 +
22 + 初めて Riebeckite を使う場合は、Guides より先に [Getting Started](../getting-started/README.md) から始めるのがおすすめです。
23 +
24 + ## コンテンツを作る
25 +
26 + ### 記事を書く
27 +
28 + [Writing Content](./writing-content.md)
29 +
30 + Markdown、Frontmatter など、Riebeckite で記事を書くための基本を説明します。
31 +
32 + ### Obsidian Vault を公開する
33 +
34 + [Obsidian](./obsidian.md)
35 +
36 + 既存の Obsidian Vault を Riebeckite の Content として利用する方法を説明します。
37 +
38 + ## サイトを構成する
39 +
40 + ### Content と Site を分ける
41 +
42 + [Content Repositories](./content-repositories.md)
43 +
44 + Site Application と Markdown Content を別の Repository で管理する構成について説明します。
45 +
46 + ### 多言語サイトを作る
47 +
48 + [Localization](./localization.md)
49 +
50 + 複数言語の Content、URL、言語切り替えなどを扱う方法を説明します。
51 +
52 + ### Analytics を使う
53 +
54 + [Analytics](./analytics.md)
55 +
56 + Riebeckite Site に Analytics を導入する方法を説明します。
57 +
58 + ### アイコンやロゴを差し替える
59 +
60 + [サイトのアイコンとロゴ](./branding.md)
61 +
62 + Site 固有の favicon、ヘッダーのロゴ、リンクプレビュー画像を差し替える方法を説明します。
63 +
64 + ### Site の UI をカスタマイズする
65 +
66 + [サイトのカスタマイズ](./customizing-your-site.md)
67 +
68 + 通常の HonoX application として `app/` の route、component、island、CSS を編集する方法を説明します。
69 +
70 + ## デプロイする
71 +
72 + デプロイ方法を選ぶ場合は、まず [Deployment](./deployment/README.md) を参照してください。
73 +
74 + ```mermaid id="kb66ux"
75 + flowchart TD
76 + Deploy["Siteを公開したい"]
77 +
78 + Deploy --> Overview["Deployment"]
79 +
80 + Overview --> Workers["Cloudflare Workers"]
81 + Overview --> Actions["GitHub Actions"]
82 + Overview --> Separate["Separate Content Repository"]
83 + ```
84 +
85 + ### Cloudflare Workers
86 +
87 + [Cloudflare Workers](./deployment/cloudflare-workers.md)
88 +
89 + Riebeckite Site を Cloudflare Workers へデプロイする方法を説明します。
90 +
91 + ### GitHub Actions
92 +
93 + [GitHub Actions](./deployment/github-actions.md)
94 +
95 + GitHub Actions を使って Build と Deployment を自動化する方法を説明します。
96 +
97 + ### Separate Content Repository
98 +
99 + [Separate Content Repository](./deployment/separate-content-repository.md)
100 +
101 + Content と Site が別 Repository にある場合の自動デプロイ構成を説明します。
102 +
103 + ## Riebeckite を更新する
104 +
105 + [Upgrading](./upgrading.md)
106 +
107 + Riebeckite の Package を新しい Version へ更新するときの手順と、変更点の確認方法を説明します。
108 +
109 + ## 目的から探す
110 +
111 + | やりたいこと | ページ |
112 + | --- | --- |
113 + | Markdown で記事を書く | [Writing Content](./writing-content.md) |
114 + | Obsidian Vault を公開する | [Obsidian](./obsidian.md) |
115 + | Content と Site を別 Repository にする | [Content Repositories](./content-repositories.md) |
116 + | 多言語 Site にする | [Localization](./localization.md) |
117 + | Analytics を導入する | [Analytics](./analytics.md) |
118 + | サイトのアイコンやロゴを差し替える | [サイトのアイコンとロゴ](./branding.md) |
119 + | Site の UI をカスタマイズする | [サイトのカスタマイズ](./customizing-your-site.md) |
120 + | Homepage と発見導線を作る | [発見導線のレシピ](./discovery-recipes.md) |
121 + | デプロイ方法を選ぶ | [Deployment](./deployment/README.md) |
122 + | Cloudflare Workers に公開する | [Cloudflare Workers](./deployment/cloudflare-workers.md) |
123 + | GitHub Actions で自動デプロイする | [GitHub Actions](./deployment/github-actions.md) |
124 + | Separate Content Repository を自動デプロイする | [Separate Content Repository](./deployment/separate-content-repository.md) |
125 + | Riebeckite をアップグレードする | [Upgrading](./upgrading.md) |
126 +
127 + ## Guides と他の章の違い
128 +
129 + ドキュメントの役割は次のように分かれています。
130 +
131 + ```text id="3m60t7"
132 + 初めてSiteを作る
133 + → Getting Started
134 +
135 + やりたい作業の手順を知る
136 + → Guides
137 +
138 + Pluginを探す
139 + → Plugins
140 +
141 + Themeを探す
142 + → Themes
143 +
144 + 設定・CLI・APIを調べる
145 + → Reference
146 +
147 + 内部構造を理解する
148 + → Framework
149 + ```
150 +
151 + Guides では、内部実装を詳しく説明することよりも、**目的を達成するために何をすればよいか**を中心に説明します。
152 +