obsidian-plugin-boilerplate
Installation
SKILL.md
Obsidian Plugin Boilerplate
Use this skill when the user wants to create a new Obsidian plugin, scaffold a clean TypeScript plugin structure, or validate core metadata before writing feature code.
What this skill provides
- A local interactive generator at
tools/create-plugin.js - Guidance for choosing automated versus manual setup
- Manifest naming and description validation before code generation
- Boilerplate expectations that align with
obsidian-plugin-dev
Recommended workflow
- Ask whether the user wants automated setup or manual setup.
- For automated setup, run
node skills/obsidian-plugin-boilerplate/tools/create-plugin.jsfrom the repo root. - For manual setup, create the same baseline files explicitly:
manifest.json,src/main.ts,src/settings.ts,styles.css,package.json,tsconfig.json,esbuild.config.mjs,version-bump.mjs,versions.json,.gitignore, andLICENSE. - After scaffolding, immediately apply
obsidian-plugin-dev,obsidian-plugin-ui-ux,obsidian-plugin-accessibility, andobsidian-plugin-submissionto keep the generated project review-ready.
Interactive setup guidance
Present the user with two options: