Can I use this for existing Obsidian plugins?

While optimized for new projects, you can use the environment configuration steps to fix or standardize the build pipeline of an existing plugin.

What prerequisites are needed for this skill?

You will need Node.js 18+ (LTS), a package manager like npm or pnpm, the Obsidian desktop application, and Git for version control.

How does hot-reload work with this setup?

The setup includes an npm run dev script that uses esbuild to watch for changes; when combined with a symlink, Obsidian detects the updated main.js file immediately.

Is the official sample plugin used as a base?

Yes, the skill clones the official obsidian-sample-plugin repository to ensure compatibility with the latest Obsidian API and best practices.

Does this skill handle symlinking on Windows?

Yes, it provides specific commands for both macOS/Linux (ln -s) and Windows (mklink /D) to ensure your plugin is correctly linked to your vault.

Obsidian Plugin Environment Setup

Name: Obsidian Plugin Environment Setup
Author: jeremylongshore

byjeremylongshore

•

1,242

•

Productivity & Workflow

Configures a complete Obsidian plugin development environment with Node.js, TypeScript, and hot-reload capabilities.

This skill streamlines the initial setup for Obsidian plugin developers by automating the creation of a standardized development environment. It handles everything from cloning the official sample template and installing TypeScript dependencies to configuring esbuild for rapid builds and creating symbolic links to your local Obsidian vault. By managing the project structure, manifest files, and build pipelines, it allows developers to focus on writing features rather than fighting with configuration files and directory paths.

Key Features

011,242 GitHub stars

02Standardized manifest.json and package.json generation

03Smart symlinking between development folders and Obsidian vaults

04Automated cloning and initialization of the official Obsidian sample template

05Pre-configured TypeScript and esbuild build pipeline

06Integrated hot-reload support for immediate testing

Use Cases

01Learning the standard directory structure and configuration for Obsidian extensions

02Starting a brand new Obsidian plugin project with best-practice architecture

03Configuring a local development environment for an existing plugin repository

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jeremylongshore/claude-code-plugins-plus-skills obsidian-install-auth

For use in Claude.ai and ChatGPT

Download Skill