Development workflow
Develop plugins in a test vault before using them in a real vault.
Local loop
Section titled “Local loop”- Create a plugin folder under
.obsidian/plugins/<plugin-id>/. - Add
manifest.json,main.js, and optionalstyles.css. - Enable the plugin in settings.
- Use developer tools and plugin diagnostics to inspect activation failures.
- Disable and re-enable the plugin after rebuilds when hot reload is not available.
Debugging
Section titled “Debugging”Use console output for development, but remove noisy logs before publishing. User-facing failures should go through notices or plugin diagnostics.
If a plugin breaks startup, open the vault in safe mode, disable the plugin, and inspect the last failure message.