Riebeckite
Menu
Color mode

Getting Started

この章は、初めて Riebeckite でサイトを公開する人のための一本道です。高度な診断、Plugin 開発、リポジトリ分離は、必要になったときに読むページへ分けています。

text
Quick Start
    ↓
Installation
    ↓
First Content
    ↓
Presets
    ↓
Deployment

Riebeckite とは

Riebeckite は、Markdown や Obsidian 形式のノートを高速な静的サイトにするためのツールです。content/ に Markdown を置き、ローカルで確認し、dist/ にビルドして公開します。

Riebeckite を使うために、このリポジトリを clone する必要はありません。create-riebeckite が、サイト用のファイル一式を生成します。

この章のページ

ページ できること
Quick Start 作成、起動、Markdown 編集、確認、ビルドを短い手順で試す
Installation 必要な環境と生成されるファイルを確認する
First Content 最初の公開ページを書く、またはサンプルを編集する
Presets starter、minimal、showcase、empty を比較する
Deployment 手元から公開し、必要なら GitHub Actions で自動化する
Obsidian Vault を使う 既存の Obsidian Vault を接続し、選んだノートを公開する
最初の Plugin を追加する Plugin を入れて ==ハイライト== 構文が効くことを確認する
最初の Theme を変える Theme を変えてデザインが変わることを確認する

最短手順

bash
npx create-riebeckite

CLI が、プロジェクト名・preset・コンテンツの取得元・デプロイ設定を順に確認します。手元で試すだけなら starter、This project、Not now のまま進めてください。

bash
cd my-site
npm install
npm exec riebeckite dev

ターミナルに表示されたローカル URL をブラウザで開きます。content/ の Markdown を編集し、公開したいページに publish: true を付けたら、最後にビルドします。

bash
npm exec riebeckite build

ビルド結果をそのまま公開する場合は、Wrangler を入れて npm exec riebeckite deploy を実行します。ログインと wrangler.jsonc の生成は自動です。詳しくは Deployment を参照してください。

preset で迷ったら、既定の starter を使ってください。

Riebeckite 本体を開発する場合 は Framework / Development へ進んでください。

Riebeckite をカスタマイズする

やりたいこと ガイド
すでに Obsidian を使っている Obsidian Vault を使う
機能を追加したい (検索、図表、埋め込み…​) 最初の Plugin を追加する
見た目を変えたい (色、フォント、レイアウト…​) 最初の Theme を変える
アイコンやロゴを差し替えたい サイトのアイコンとロゴ

次に読むページ

History

1 changesCollapseExpand
1 + ---
2 + title: Getting Started
3 + sidebar:
4 + label: Getting Started
5 + order: 10
6 + ---
7 + # Getting Started
8 +
9 + この章は、初めて Riebeckite でサイトを公開する人のための一本道です。高度な診断、Plugin 開発、リポジトリ分離は、必要になったときに読むページへ分けています。
10 +
11 + ```text
12 + Quick Start
13 + ↓
14 + Installation
15 + ↓
16 + First Content
17 + ↓
18 + Presets
19 + ↓
20 + Deployment
21 + ```
22 +
23 + ## Riebeckite とは
24 +
25 + Riebeckite は、Markdown や Obsidian 形式のノートを高速な静的サイトにするためのツールです。`content/` に Markdown を置き、ローカルで確認し、`dist/` にビルドして公開します。
26 +
27 + Riebeckite を使うために、このリポジトリを clone する必要はありません。[`create-riebeckite`](https://www.npmjs.com/package/create-riebeckite) が、サイト用のファイル一式を生成します。
28 +
29 + ## この章のページ
30 +
31 + | ページ | できること |
32 + | --- | --- |
33 + | [Quick Start](./quick-start.ja.md) | 作成、起動、Markdown 編集、確認、ビルドを短い手順で試す |
34 + | [Installation](./installation.ja.md) | 必要な環境と生成されるファイルを確認する |
35 + | [First Content](./first-content.ja.md) | 最初の公開ページを書く、またはサンプルを編集する |
36 + | [Presets](./presets.ja.md) | `starter`、`minimal`、`showcase`、`empty` を比較する |
37 + | [Deployment](./deployment.ja.md) | 手元から公開し、必要なら GitHub Actions で自動化する |
38 + | [Obsidian Vault を使う](./obsidian-vault.ja.md) | 既存の Obsidian Vault を接続し、選んだノートを公開する |
39 + | [最初の Plugin を追加する](./first-plugin.ja.md) | Plugin を入れて `==ハイライト==` 構文が効くことを確認する |
40 + | [最初の Theme を変える](./first-theme.ja.md) | Theme を変えてデザインが変わることを確認する |
41 +
42 + ## 最短手順
43 +
44 + ```bash
45 + npx create-riebeckite
46 + ```
47 +
48 + CLI が、プロジェクト名・preset・コンテンツの取得元・デプロイ設定を順に確認します。手元で試すだけなら `starter`、`This project`、`Not now` のまま進めてください。
49 +
50 + ```bash
51 + cd my-site
52 + npm install
53 + npm exec riebeckite dev
54 + ```
55 +
56 + ターミナルに表示されたローカル URL をブラウザで開きます。`content/` の Markdown を編集し、公開したいページに `publish: true` を付けたら、最後にビルドします。
57 +
58 + ```bash
59 + npm exec riebeckite build
60 + ```
61 +
62 + ビルド結果をそのまま公開する場合は、Wrangler を入れて `npm exec riebeckite deploy` を実行します。ログインと `wrangler.jsonc` の生成は自動です。詳しくは [Deployment](./deployment.ja.md) を参照してください。
63 +
64 + preset で迷ったら、既定の `starter` を使ってください。
65 +
66 + > **Riebeckite 本体を開発する場合** は [Framework / Development](../framework/development.ja.md) へ進んでください。
67 +
68 + ## Riebeckite をカスタマイズする
69 +
70 + | やりたいこと | ガイド |
71 + | --- | --- |
72 + | すでに Obsidian を使っている | [Obsidian Vault を使う](./obsidian-vault.ja.md) |
73 + | 機能を追加したい (検索、図表、埋め込み…​) | [最初の Plugin を追加する](./first-plugin.ja.md) |
74 + | 見た目を変えたい (色、フォント、レイアウト…​) | [最初の Theme を変える](./first-theme.ja.md) |
75 + | アイコンやロゴを差し替えたい | [サイトのアイコンとロゴ](../guides/branding.ja.md) |
76 +
77 + ## 次に読むページ
78 +
79 + - [Quick Start →](./quick-start.ja.md)
80 +