Cookiecutter Obsidian Plugin¶

Cookiecutter template for creating Obsidian plugins with a ready-to-use structure and tooling.

Quick Start¶

Using cookiecutter directly¶

# Install cookiecutter
pip install cookiecutter

# Create project
cookiecutter https://github.com/serafinovsky/cookiecutter-obsidian-plugin -o your-obsidain-vault/.obsidian/plugins/

# Setup plugin development environment
cd your-plugin-id
make install
make dev 

Using CLI tool¶

# Install the CLI tool
pip install cookiecutter-obsidian-plugin

# Or with custom options
cookiecutter-obsidian-plugin --output-dir your-obsidain-vault/.obsidian/plugins/

# Setup plugin development environment
cd your-plugin-id
make install
make dev 

Key Features¶

Modern Tools¶

TypeScript, ESLint, esbuild, and optional Vitest and i18n setup

CI/CD Ready¶

GitHub Actions with ready-to-use release workflow for plugins.

CI/CD · Release Workflow

Code Quality¶

ESLint (linter), Prettier (formatter), and optional tests — all configured automatically

Documentation¶

• After Install - What to do after project generation
• Prompt Arguments - All configuration parameters

License¶

MIT License