Day14 Obsidian 建立第一個外掛

既然我們需要修正外掛,那就要先找到obsidian的開發者文件 https://marcus.se.net/obsidian-plugin-docs/

當我們第一次拿到一份新的文件,首先要進行的就是成功將他的範例照個他的教學成功啟動一遍

而這篇文章中有提供Getting Started,那目前的目標就是將這個教學成功的啟動他

一開始他介紹了這個專案是使用了typescript,所以要先準備node的環境,另外也需要git來抓下他需要的code

接著就是建立第一個plugin了 https://marcus.se.net/obsidian-plugin-docs/getting-started/create-your-first-plugin

他在文章開頭提到,我們要先建立一個全新的vault,以防這個外掛去影響到你的主要的資料存放區(建議這個vault不要放在icloud中,會容易有問題,我是選擇放在"~/Developer/side-project/obsidian/plugin-development")

因此我們點選obsidian左方的保險櫃圖示,並選取建立一個新的vault

緊接著將他的範例plugin放到你剛剛建立的vault的資料夾下的.obsidian/plugin

所以請用terminal或是iterm2先cd到你指定的資料夾

cd ~/Developer/side-project/obsidian/plugin-development/.obsidian/plugins

如果你是剛建立的vault,那應該不會有plugins的資料夾,所以要先建立再cd進去

mkdir ~/Developer/side-project/obsidian/plugin-development/.obsidian/plugins
cd ~/Developer/side-project/obsidian/plugin-development/.obsidian/plugins

緊接著將範例的plugin的code 放進去

git clone [email protected]:obsidianmd/obsidian-sample-plugin.git

緊接著用你習慣的文字編輯器打開這個資料夾

如果想要在mac中看到隱藏的資料夾,請按下cmd+shift+.(dot)就可以看到了

緊接著,在這個專案中執行

npm install
npm run dev

接著,打開你的obsidian,點選第三方套外掛程式,就可以看到你剛剛增加的plugin了

如果說已經跑了npm run dev了,卻沒有在第三方這邊看到,可以關閉設定,按下cmd+p,並打上"重新",選擇"放棄儲存並重新載入程式,或是將obsidian關掉重開,就會看到了

如此,我們就成功完成了他的第一份教學,建立第一個自己的外掛了

接下來我們就可以來將我們目標的plugin來進行改造了