プロジェクト構成
生成された Riebeckite サイトは小さな静的サイトプロジェクトです。コンテンツとサイト実装を一緒に置くことも、分けることもできます。対応する配置は次の3つです。
| 配置 | コンテンツ | サイト実装 | 向いている場面 |
|---|---|---|---|
| 一体型 | サイトリポジトリ内の content/ |
同じリポジトリ | 1人、または1つのリポジトリで全体を管理する |
| ディレクトリ分離型 | site/ の隣の vault/ |
同じリポジトリ | Obsidian Vault とサイト実装を明確に分けたい |
| リポジトリ分離型 | 別リポジトリ | 専用リポジトリ | サイト実装を触らずに記事だけ更新したい |
一体型のファイル
my-site/
├── content/
│ ├── index.md
│ ├── notes/
│ └── assets/
├── app/
├── public/
├── riebeckite.config.ts
├── package.json
├── wrangler.jsonc
└── .github/workflows/publish.yml
このツリーは --github-actions や --cloudflare-workers などのデプロイ指定を前提にしています。既定の Not now では wrangler.jsonc と .github/workflows/publish.yml は生成されません。
content/が既定のコンテンツディレクトリです。app/には生成された HonoX アプリがあります。public/には favicon など、そのまま配信するファイルを置きます。riebeckite.config.tsでsite、content.directory、テーマ、プラグインを設定します。wrangler.jsoncは Cloudflare Worker とカスタムドメインを定義します。dist/はnpm exec riebeckite buildが生成する出力で、コミットしません。
ディレクトリ分離型
my-project/
├── vault/
│ ├── index.md
│ ├── notes/
│ └── assets/
├── site/
│ ├── app/
│ ├── riebeckite.config.ts
│ ├── package.json
│ └── wrangler.jsonc
└── .github/workflows/publish.yml
package.json があるのはサイトディレクトリだけです。設定から Vault を参照します。
export default defineConfig({
content: { directory: "../vault" },
// ...
});
コマンドは site/ で実行します。ワークフローには working-directory: site を設定し、push の対象パスに Vault を含めます。
リポジトリ分離型
my-site/ my-vault/
├── app/ ├── index.md
├── riebeckite.config.ts ├── notes/
├── package.json └── assets/
└── .github/workflows/
サイトのワークフローは、ビルド前に Vault を content/ へチェックアウトします。Vault のワークフローは push 後に repository_dispatch をサイトへ送ります。
次に読む
Powered by Riebeckite