初めての Obsidian プラグインをビルドしてリリースする方法
使うタイミング: 具体的なワークフロー改善のアイデアがあり、1日でプラグインを作りたいとき。
前提条件
- Node 18+ — nvm install 18
- テスト用のローカル Vault — 開発専用の新しい Obsidian Vault を作成してください
- スキルのクローン — git clone https://github.com/gapmiss/obsidian-plugin-skill ~/.claude/skills/obsidian-plugin-skill
フロー
-
プラグインをスキャフォールドするScaffold an Obsidian plugin called 'smart-outline' with a command and a settings tab.✓ コピーしました→ manifest、main.ts、ビルド設定を含むフォルダ
-
機能を追加するImplement: on command, open a modal showing the outline of the active note.✓ コピーしました→ アクティブな MarkdownView から読み取るモーダルが動作する
-
サイドロードしてテストするInstall into the dev vault's plugins folder and reload Obsidian.✓ コピーしました→ プラグインが表示され、コマンドが動作する
-
リリースを準備するCreate versions.json and tag a v0.1.0 release.✓ コピーしました→ main.js + manifest.json が添付された GitHub リリース
結果: コミュニティストアに提出できる、動作するインストール可能なプラグイン。
注意点
- versions.json を忘れるとコミュニティストアにリジェクトされる — スキルがリマインドします。常に manifest.json と同期を保ってください
- API に含まれない Obsidian の内部実装を参照してしまう — 公開 API のみを使用し、内部実装は不安定なものとして扱ってください