Obsidianプラグイン開発
多分こちらを読めば必要なことは全部わかる
公式ドキュメント
基本
前提
Node.jsのインストール
Gitのインストール
コードはどこに置く?
コミュニティプラグインのファイルは.obsidian/plugins内に作られる
自分用に作る場合もここにフォルダを作る
最終的に必要なファイル
main.js(必須)
処理を書く
manifest.json(必須)
プラグインの情報を書く
styles.css
CSSを書く必要があれば
data.json
プラグインの設定を保存する必要があれば
準備
①まずサンプルをpluginsフォルダ内にコピーする
git clone https://github.com/obsidianmd/obsidian-sample-plugin.git
またはzipをダウンロードして展開(この場合Gitのインストールは不要)
②npm iで必要なパッケージを一括インストール
Node.jsのインストールが必要
npm iとは?
npm i パッケージ名で指定したパッケージをインストールする
npm iでpackage.json内に記述されたパッケージを一括でインストールする(今回はこちら)
③npm run devでmain.ts(TypeScriptのコード)をmain.js(JavaScript)にコンパイル
サンプルにはmain.jsファイルがないのでmain.tsから生成する必要がある
npm runとは?
package.json内のscriptsプロパティで設定されたコマンドが動く
このpackage.jsonでは"dev": "node esbuild.config.mjs"とあるので、npm run devでNode.jsのesbuild.config.mjsというファイルが実行される
このファイルにTypeScriptからJavaScriptへのコンパイル方法が記述されている(弄る必要はない)
④main.tsを開いて自分でコードを書き換えてみる