obsidian-vite
This is a template repository for an Obsidian plugin bundled with Vitejs.
Out of the box support
- Typescript
- Solid (default) or React
- Tailwindcss
- ESlint
Usage
-
npm run devwill automatically watch and build your plugin when you save changes. If using the hot-reload plugin (which you should be), you may want to use my PR to ensure rendering-related changes are hot reloaded correctly. -
main.jsandstyles.cssoutput to the root directory of the repo. Place the repo in/yourvault/.obsidian/plugins/to be able to test out your plugin. -
Tailwind is scoped to children of an element with the
twcssclass. Make sure your view/codeblock/whatever has this class to enable tw utility classes for its children.
- Replace the following words in all files to your liking:
- obsidian-vite
- Obsidian Vite
- ObsidianVite
- Look over
/manifest.jsonand adjust as needed. - Look over
/tsconfig.app.json,/vite.config.ts,/src/main.tsxand comment/uncomment depending on whether you want to use React or Solid.
License
MIT
Contributing
- Open an issue for bugs and feature requests
- PRs welcome!