obsidian-local-dev-loop

Featured

Set up a fast Obsidian plugin development loop with hot reload. Covers cloning the sample plugin, esbuild watch mode, symlinking into a vault, Ctrl+R hot reload, Chrome DevTools debugging, and testing with vitest. Use when starting plugin development or configuring a dev environment. Trigger with "obsidian dev loop", "obsidian hot reload", "obsidian development setup", "develop obsidian plugin".

AI & Automation 2,926 stars 433 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 99/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Obsidian Local Dev Loop ## Overview Establish a fast edit-build-test cycle for Obsidian plugins. Clone the official sample plugin, run esbuild in watch mode, symlink into a dev vault, hot-reload with Ctrl+R, debug with Chrome DevTools, and run tests with vitest. Aimed at sub-second feedback from save to reload. ## Prerequisites - Node.js 18+ with npm - Git - Obsidian desktop app installed - A vault dedicated to development (keep it separate from your real notes) ## Instructions ### Step 1: Clone the official sample plugin Start from the maintained template rather than from scratch: ```bash set -euo pipefail git clone https://github.com/obsidianmd/obsidian-sample-plugin.git my-plugin cd my-plugin rm -rf .git git init npm install ``` The sample includes `esbuild.config.mjs`, `tsconfig.json`, `manifest.json`, and a working `src/main.ts`. ### Step 2: Create a dedicated dev vault Keep a vault just for testing. Pre-populate it with sample notes. ```bash set -euo pipefail DEV_VAULT="$HOME/ObsidianDev" mkdir -p "$DEV_VAULT/.obsidian/plugins" mkdir -p "$DEV_VAULT/Test Notes" cat > "$DEV_VAULT/Test Notes/Sample.md" << 'EOF' --- tags: [test, sample] --- # Sample Note This note exists for plugin development testing. ## Section A Some content with a [[link]] and a #tag. ## Section B - Item 1 - Item 2 - Item 3 EOF echo "Dev vault ready at $DEV_VAULT" ``` Open this vault in Obsidian: File > Open vault > select `~/ObsidianDev`. ### Step 3: Symlink the plugin into th...

Details

Author
jeremylongshore
Repository
jeremylongshore/claude-code-plugins-plus-skills
Created
1 years ago
Last Updated
yesterday
Language
Python
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category