My Plugin
unlistedby Sébastien Dubois
TODO: Add your plugin description here
Obsidian Plugin Template (Bun)
A modern Obsidian plugin template using Bun as the package manager and bundler, with TypeScript, Tailwind CSS v4, ESLint, Prettier, and automated release workflows.
Features
- 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
Getting Started
See TEMPLATE_USAGE.md for detailed instructions on how to use this template to create your own Obsidian plugin.
Quick Start
- 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
Development
See DEVELOPMENT.md for detailed development instructions.
Prerequisites
Commands
| 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 |
Contributing
See CONTRIBUTING.md for contribution guidelines.
License
MIT License - see LICENSE for details.
News & support
To stay up to date about this plugin, Obsidian in general, Personal Knowledge Management and note-taking:
- Subscribe to my newsletter
- Subscribe to my YouTube channel
- Join the Knowii community and learn to organize your notes and put your knowledge to work, together with fellow knowledge workers
If this plugin is useful to you, here are the best ways to support my work ❤️:
- Join the Knowii community
- Become a GitHub Sponsor
- Buy me a coffee
- Subscribe to my YouTube channel
- Check out my products
Found a bug or have an idea? Open an issue.
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.