My Obsidian Plugin

unlisted

by Aitor Llamas Jiménez

★ 2 starsUpdated 2mo ago
View on GitHub

Obsidian Plugin Starter Kit React + Tailwind CSS

Initialization

To initialize the plugin with your own values, run the initialization script:

Interactive mode

npm run init

The script will ask you for:

  • Plugin ID: In kebab-case format (e.g: my-plugin)
  • Plugin name: Readable name (e.g: My Plugin)
  • Description: Optional plugin description

CLI arguments mode

npm run init -- --id my-plugin --name "My Plugin" --description "Plugin description"

The script will automatically update all necessary files:

  • manifest.json
  • package.json
  • esbuild.config.mjs
  • src/main.tsx
  • src/components/App.tsx
  • src/settings-tab.ts
  • README.md

Development

After initializing, you can start developing:

# Install dependencies
npm install

# Development mode
npm run dev

# Build
npm run build

# Install in Obsidian vault
npm run dev-install <path-to-vault>

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.