Obsidianプラグインのビルド手順
GitHubから入手したソースコードをビルドして、Obsidianで使えるようにするまでの備忘録。
1. 事前準備
Node.js がインストールされていること
ターミナル(コマンドプロンプトやターミナル.app)を開く
2. 手順
ディレクトリへ移動
cd /path/to/your/plugin-folder
依存関係のインストール
npm install
※ yarn.lock がある場合は yarn
1 high severity vulnerabilityが出た場合
npm audit fixで対応
ビルドの実行
npm run build
成功すると main.js が生成される
3. Obsidianへの配置
保管庫(Vault)内の以下の場所にファイルを移動する
[Vault]/.obsidian/plugins/[プラグイン名]/
必要なファイル一式:
main.js (ビルドで生成されたもの)
manifest.json (もともとあるもの)
styles.css (もしあれば)
4. 有効化
Obsidianの Settings > Community plugins を開く
Installed plugins の リロードボタン を押す
出現したプラグインを ON にする
トラブルシューティング
常に最新状態にしたい(開発用)場合: npm run dev
権限エラーが出る場合: sudo npm install (Mac/Linux)