Web DevelopmentDev.to
December 30, 20251 min read0 views
Share:

How to Develop an Obsidian Plugin - Getting Started Guide

A quick guide to get started with Obsidian plugin development. curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash nvm install node npm install -g esbuild Download the Obsidian Sample Plugin from GitHub Place it in your

A quick guide to get started with Obsidian plugin development.

Setup

1. Install NVM and Node.js

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install node

2. Install esbuild

npm install -g esbuild

Install Sample Plugin in Obsidian

  1. Download the Obsidian Sample Plugin from GitHub
  2. Place it in your vault's .obsidian/plugins/ directory
  3. Run the development server: npm run dev
  4. Enable the plugin in Obsidian Settings > Community Plugins

Debugging

Since Obsidian is an Electron app, you can use Chromium developer tools:

  • macOS: Cmd + Opt + I
  • Windows/Linux: Ctrl + Shift + I

Originally published at my blog

Originally published on Dev.to

Read Original Article

Subscribe to Our Newsletter

Get the latest tech news, insights, and updates delivered straight to your inbox. Join our community of tech enthusiasts!

We respect your privacy. Unsubscribe at any time. Unsubscribe here