A modern Obsidian plugin template using Bun as the package manager and bundler, with TypeScript, Tailwind CSS v4, ESLint, Prettier, and automated release workflows.
- Bun for fast package management and bundling
- TypeScript with strict configuration
- Tailwind CSS v4 for styling
- ESLint + Prettier for code quality
- Husky + lint-staged for pre-commit hooks
- Commitizen + Conventional Commits for standardized commit messages
- GitHub Actions for CI/CD and automated releases
- Immer for immutable state management
- Zod for runtime validation
See TEMPLATE_USAGE.md for detailed instructions on how to use this template to create your own Obsidian plugin.
- Click "Use this template" on GitHub to create a new repository
- Clone your new repository
- Follow the setup instructions in TEMPLATE_USAGE.md
- Run
bun installto install dependencies - Run
bun run devto start development
See DEVELOPMENT.md for detailed development instructions.
| Command | Description |
|---|---|
bun install |
Install dependencies |
bun run dev |
Development build with watch mode |
bun run build |
Production build |
bun run tsc:watch |
Type check in watch mode |
bun run lint |
Run ESLint |
bun run format |
Format with Prettier |
bun test |
Run tests |
See CONTRIBUTING.md for contribution guidelines.
MIT License - see LICENSE for details.
To stay up to date about this plugin, Obsidian in general, Personal Knowledge Management and note-taking, subscribe to my newsletter. Note that the best way to support my work is to become a paid subscriber ❤️.