Obsidian のノートをサイトにする
Riebeckite では、普段使っている Obsidian Vault をそのまま記事の置き場所として利用できます。
既存の Vault を Riebeckite 用に作り直したり、Markdown を別の形式へ変換したりする必要はありません。
基本的な流れは次のとおりです。
Diagram source
flowchart LR
Obsidian["Obsidianで書く"]
Publish["publish: true"]
Riebeckite["Riebeckite"]
Preview["ブラウザで確認"]
Site["公開Site"]
Obsidian --> Publish
Publish --> Riebeckite
Riebeckite --> Preview
Preview --> SiteRiebeckite に Vault の場所を指定し、公開したいノートだけに publish: true を付けるのが基本です。
既存の Vault はそのまま使える
Obsidian Vault は Markdown ファイルが入ったフォルダです。
Riebeckite も指定されたフォルダから Markdown を読み込むため、content.directory に Vault の場所を指定すれば Content として利用できます。
たとえば、
notes/
├─ Welcome.md
├─ Programming/
│ └─ Flutter.md
├─ private/
│ └─ memo.md
└─ .obsidian/という既存 Vault を、そのまま Riebeckite から読み込めます。
通常の、
dev
check
doctor
inspect
buildを実行しても、Riebeckite が Vault の Markdown を整理したり、勝手に書き換えたりすることはありません。
ノートの編集はこれまでどおり Obsidian で行います。
公開するノートを選ぶ
既定の公開ルールでは、Frontmatter に、
publish: trueがあるノートだけを公開します。
たとえば、
---
title: 公開する記事
publish: true
---
この記事は公開されます。とします。
一方、
---
title: 個人的なメモ
---
これは個人的なメモです。には publish: true がないため、公開対象になりません。
Diagram source
flowchart TD
Vault["Obsidian Vault"]
Vault --> A["公開記事<br/>publish: true"]
Vault --> B["下書き"]
Vault --> C["個人的なメモ"]
A --> Site["Public Site"]
B -.->|"公開しない"| Site
C -.->|"公開しない"| Siteそのため、
公開記事と個人的なノートを同じ Vault に置いたまま運用できます。
Vault の置き方
Vault の配置方法は、大きく2つあります。
パターンA：Site の content/ を Vault にする
最も簡単な方法です。
Riebeckite Site の、
content/をそのまま Obsidian Vault として開きます。
my-site/
├─ content/ ← Obsidianで開く
│ ├─ Welcome.md
│ └─ Articles/
│ └─ FirstArticle.md
│
├─ riebeckite.config.ts
└─ package.jsonこの場合は標準設定のまま利用できます。
content: {
directory: "content",
},初めて Riebeckite と Obsidian を組み合わせるなら、この方法が最も単純です。
my-site/content/
↓
Obsidian Vault
↓
Riebeckite Content同じフォルダが両方の役割を持ちます。
パターンB：既存 Vault を利用する
すでに Obsidian Vault がある場合は、Site の外に置いたまま利用できます。
たとえば、
workspace/
├─ notes/ ← 既存のObsidian Vault
│ ├─ Welcome.md
│ ├─ Programming/
│ └─ .obsidian/
│
└─ my-site/ ← Riebeckite Site
├─ app/
├─ riebeckite.config.ts
└─ package.jsonという構成にします。
my-site/riebeckite.config.ts から Vault を指定します。
content: {
directory: "../notes",
},これだけで notes/ を Riebeckite の Content Directory として利用できます。
Diagram source
flowchart LR
Vault["notes/<br/>Obsidian Vault"]
Site["my-site/<br/>Riebeckite"]
Build["Build"]
Public["Public Site"]
Vault --> Build
Site --> Build
Build --> PublicVault を Site Directory へコピーする必要はありません。
Repository 自体も分離したい場合は、記事とサイトのリポジトリ分離 を参照してください。
どちらを選ぶ？
迷った場合は、次の基準で選べます。
| 状況 | おすすめ |
|---|---|
| 初めて Riebeckite を使う | content/ を Vault にする |
| すでに Vault がある | 既存 Vault を指定する |
| Vault と Site の Git 履歴を分けたい | Repository を分離する |
| Vault を Private Repository にしたい | Repository を分離する |
既存 Vault があるなら、Riebeckite のためだけに移動する必要はありません。
Obsidian で記事を書く
公開する記事には、最低限 title と publish を指定します。
---
title: 記事のタイトル
publish: true
---
本文を書きます。本文は通常の Markdown として書けます。
# 見出し
本文を書きます。
## 次の見出し
さらに本文を書きます。Obsidian の WikiLink も利用できます。
詳しくは [[別の記事]] を参照してください。対応する Plugin が、Riebeckite の Content 情報を使って公開先のリンクを解決します。
ファイル名と URL
ファイル名は Content の識別や既定の Public Location を決める材料になります。
たとえば、
getting-started.mdのような分かりやすい名前にしておくと、Vault と Site の両方で管理しやすくなります。
ただし、Riebeckite では最終的な URL は解決済みの Public Location として扱われます。
そのため、
ファイルの物理Path
=
常に公開URLと考えないようにしてください。
Plugin や設定によって Public Location が変更される場合があります。
URL の仕組みを詳しく知りたい場合は Content System を参照してください。
Obsidian の設定ファイル
Vault には通常、
.obsidian/があります。
これは Obsidian 自体の設定であり、記事ではありません。
必要に応じて content.exclude から除外できます。
content: {
directory: "../notes",
exclude: [
".obsidian/**",
],
},Template や Private Directory も Content として読み込みたくない場合は、
content: {
directory: "../notes",
exclude: [
".obsidian/**",
"Templates/**",
"private/**",
],
},のように指定できます。
exclude と publish: true
この2つは役割が異なります。
Diagram source
flowchart LR
Vault["Vault"]
Vault --> Exclude{"exclude?"}
Exclude -->|"Yes"| Ignore["読み込まない"]
Exclude -->|"No"| Read["Contentとして読む"]
Read --> Publish{"publish: true?"}
Publish -->|"Yes"| Public["公開"]
Publish -->|"No"| Private["公開しない"]exclude は、
Riebeckite に Content として読み込ませないもの
を指定します。
publish: true は、
読み込んだ Content の中から公開するもの
を指定します。
たとえば、
.obsidian/
Templates/
private/のように明らかに Site で扱わない Directory は exclude し、それ以外の Note は publish: true で公開を選ぶ、という使い方ができます。
非公開メモを混ぜる
Private Note や下書きを同じ Vault に置く場合は、publish: true を付けません。
---
title: 個人的なメモ
---
公開しない内容です。既定の公開ルールなら、この Note は Site に公開されません。
一方、公開記事は、
---
title: 公開記事
publish: true
---
公開する内容です。とします。
Private Vault を扱う場合は、公開するものだけを明示する運用にすると管理しやすくなります。
公開記事から非公開ノートへのリンク
公開記事から、
[[個人的なメモ]]のように非公開 Note へリンクしてしまうことがあります。
公開前には、
npm exec riebeckite doctorなどで問題がないか確認してください。
Site 内リンクの整合性を診断する Plugin を利用している場合は、公開先が存在しない WikiLink なども検出できます。
画像と添付ファイル
画像や添付ファイルも Vault 内で管理できます。
たとえば、
notes/
├─ article.md
└─ images/
└─ photo.jpgのようにします。
Markdown からは、
のように参照できます。
ただし、ここでは Markdown から画像を参照できることと、画像ファイル自体が公開 Site に存在することを分けて考える必要があります。
Diagram source
flowchart LR
Note["Markdown"]
Link["画像への参照"]
Public["Public Asset"]
Browser["Browser"]
Note --> Link
Link --> Public
Public --> BrowserVault の外にある File や、Build 後の Public Output に存在しない File は表示できません。
添付ファイルを Site へ公開する構成では、公開対象の Asset が実際に Output へ含まれていることも確認してください。
名前が重複したときのリンク解決
Riebeckite は [[リンク]] を Note の Path、Alias、添付ファイル名から解決します。同じ名前の Note、Alias、添付ファイルが複数あると、名前だけの [[note]] では対象を1つに特定できません。
このとき Riebeckite は推測せず、リンクを未解決のままにし、doctor が曖昧なリンクとして報告します。
x/dup.md
y/dup.md[[dup]] ← 曖昧
[[x/dup]] ← Path を指定しているので x/dup.md に解決公開するリンクが必ず1つの対象を指すように、Folder を含む Path を書くか、どちらかのファイル名を変更してください。
Site を確認する
記事を書いたら、Riebeckite Site の Directory で Development Server を起動します。
npm exec riebeckite devBrowser で公開対象の記事を確認します。
問題がないか確認する場合は、
npm exec riebeckite check
npm exec riebeckite doctorを実行できます。
実際に Riebeckite がどの Content を認識しているか確認したい場合は、
npm exec -- riebeckite inspect content --listを利用できます。
記事が表示されないとき
記事が表示されない場合は、次の順番で確認すると原因を絞りやすくなります。
Diagram source
flowchart TD
Start["記事が表示されない"]
Start --> Dir{"正しいVaultを<br/>読んでいる？"}
Dir -->|No| Config["content.directoryを確認"]
Dir -->|Yes| Excluded{"excludeされている？"}
Excluded -->|Yes| Exclude["content.excludeを確認"]
Excluded -->|No| Publish{"publish: true<br/>がある？"}
Publish -->|No| Frontmatter["Frontmatterを追加"]
Publish -->|Yes| Diagnose["check / doctor"]解決済みの Content Directory は、
npm exec riebeckite inspect configで確認できます。
読み込まれている Content は、
npm exec -- riebeckite inspect content --listで確認できます。
普段の使い方
設定が終わった後は、特別な操作はほとんど必要ありません。
Diagram source
flowchart TD
Write["Obsidianでノートを書く"]
Decide{"公開する？"}
Decide -->|Yes| Publish["publish: true"]
Decide -->|No| Private["そのまま"]
Write --> Decide
Publish --> Dev["Riebeckiteで確認"]
Private --> Write
Dev --> Push["Commit / Deploy"]つまり、普段の執筆方法はこれまでとほぼ同じです。
Obsidian で書き、公開したい Note にだけ publish: true を付けます。
Riebeckite は、その Vault を公開 Site の Content Source として利用します。
まとめ
Obsidian と Riebeckite の関係はシンプルです。
Obsidian Vault
↓
Markdown
↓
Riebeckite
↓
publish: true のNote
↓
Public Site既存 Vault を Riebeckite 用に作り直す必要はありません。
最初から始めるなら、
my-site/content/
→ Obsidian Vault既存 Vault があるなら、
notes/
→ 既存Vault
my-site/
→ Riebeckite Siteという構成が使えます。
Vault の場所と公開範囲は分けて考えます。
content.directory→ どの Vault を読むかexclude→ 何を Content として読まないかpublish: true→ 何を Site に公開するか
この3つを分けて設定すれば、普段の Obsidian Vault に非公開 Note を残したまま、必要な記事だけを Riebeckite で公開できます。