Obsidian × Docusaurus Template

Obsidian のノートを Docusaurus (TypeScript) で公開するためのテンプレートです。vault/ で執筆し、scripts/sync-from-vault.mjs で website/ にコピーしてデプロイします。

ディレクトリ構成

• vault/ : Obsidian 用 vault。カテゴリごとの雛形・テンプレを配置
• website/ : Docusaurus v3 サイト (TypeScript)。npm start でプレビュー
• scripts/ : vault からサイトへコピーするユーティリティ

初回セットアップ

cd website
npm install

ルートにも npm script を用意しています。

npm run sync:vault        # vault → website コピー
npm run website:start    # 同期後に website 側の dev server を起動
npm run website:build    # 同期後に本番ビルド

Obsidian では vault/OBSIDIAN_SETUP.md を参照してプラグインを有効化してください。

更新フロー

1. Obsidian でノートを編集 (例: vault/docs/)
2. ルートで node scripts/sync-from-vault.mjs
3. cd website; npm start で確認
4. npm run build で静的ファイルを生成、任意の方法でデプロイ

GitHub Pages への応用

website/docusaurus.config.ts の url / baseUrl / organizationName / projectName を自分のリポジトリに合わせて変更してください。GitHub Actions を追加すれば自動デプロイも可能です。