Obsidian Plugin Starter

A production-ready Obsidian plugin template with TypeScript, esbuild hot reload, settings tab, commands, modals, and ribbon icons.

Features

• TypeScript — Full type safety with the Obsidian API
• esbuild — Fast builds with hot reload in dev mode
• Settings Tab — Configurable greeting, ribbon toggle, date format
• 5 Commands — Greeting, timestamp insert, modal, word count, checkbox toggle
• Ribbon Icon — Quick-access sidebar button
• Status Bar — Plugin status indicator
• File Events — Hooks into workspace file-open events
• Modal — Sample modal for building custom UI

Quick Start

# Install dependencies
npm install

# Development (watch mode with hot reload)
npm run dev

# Production build
npm run build

Development Setup

1. Clone this repo into your vault's .obsidian/plugins/ directory
2. Run npm install
3. Run npm run dev
4. Enable the plugin in Obsidian → Settings → Community Plugins
5. Edit src/main.ts and changes will rebuild automatically

Commands

Command	Description
Show greeting	Displays your configured greeting message
Insert timestamp	Inserts today's date at cursor position
Open sample modal	Opens an example modal dialog
Count words	Counts words in the current file
Toggle checkbox	Toggles - [ ] / - [x] on the current line

Project Structure

├── src/
│   └── main.ts          # Plugin entry point (commands, settings, modal)
├── styles.css            # Plugin styles (auto-loaded by Obsidian)
├── manifest.json         # Obsidian plugin manifest
├── versions.json         # Version compatibility map
├── esbuild.config.mjs    # Build configuration
├── version-bump.mjs      # Auto-bumps manifest on npm version
├── tsconfig.json         # TypeScript config
└── package.json

Customization

1. Update manifest.json with your plugin ID, name, and author
2. Edit src/main.ts to add your own commands, views, and logic
3. Add styles in styles.css
4. Update minAppVersion in manifest.json if you use newer Obsidian APIs

Publishing

1. Update version: npm version patch/minor/major
2. Build: npm run build
3. Create a GitHub release with main.js, manifest.json, and styles.css
4. Submit to Obsidian Community Plugins

Resources

• Obsidian Plugin API Docs
• Obsidian API Reference
• Sample Plugin

License

MIT