How to build and release your first Obsidian plugin
Quando usar: You have a concrete workflow improvement and want a plugin in a day.
Fluxo
-
Scaffold the pluginScaffold an Obsidian plugin called 'smart-outline' with a command and a settings tab.✓ Copiado→ Folder with manifest, main.ts, build config
-
Add the featureImplement: on command, open a modal showing the outline of the active note.✓ Copiado→ Working modal reading from the active MarkdownView
-
Side-load and testInstall into the dev vault's plugins folder and reload Obsidian.✓ Copiado→ Plugin shows up, command works
-
Prepare a releaseCreate versions.json and tag a v0.1.0 release.✓ Copiado→ GitHub release with main.js + manifest.json attached
Resultado: A working, installable plugin you can submit to the Community store.
Armadilhas
- Forgetting versions.json — Community store rejects — Skill reminds; always keep it in sync with manifest.json
- Referencing Obsidian internals that aren't part of the API — Stick to the public API; treat internals as volatile
Combine com: filesystem · github