Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unxok/obsidian-vite
Obsidian plugin template using Vite, TS, Tailwindcss, and React or Solid
https://github.com/unxok/obsidian-vite
obsidian obsidian-md obsidian-plugin
Last synced: 2 months ago
JSON representation
Obsidian plugin template using Vite, TS, Tailwindcss, and React or Solid
- Host: GitHub
- URL: https://github.com/unxok/obsidian-vite
- Owner: unxok
- License: mit
- Created: 2024-07-20T03:31:44.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T20:22:20.000Z (5 months ago)
- Last Synced: 2024-10-01T09:23:39.242Z (3 months ago)
- Topics: obsidian, obsidian-md, obsidian-plugin
- Language: JavaScript
- Homepage:
- Size: 246 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# obsidian-vite
This is a template repository for an [Obsidian](obsidian.com) plugin bundled with [Vitejs](https://vitejs.dev).
## Out of the box support
- [Typescript](https://www.typescriptlang.org)
- [Solid](https://solidjs.com) (default) _or_ [React](https://react.dev)
- [Tailwindcss](https://tailwindcss.com)
- [ESlint](https://eslint.org)## Usage
- `npm run dev` will automatically watch and build your plugin when you save changes. If using the [hot-reload](https://github.com/pjeby/hot-reload?tab=ISC-1-ov-file#readme) plugin (which you should be), you may want to use [my PR](https://github.com/pjeby/hot-reload/pull/15) to ensure rendering-related changes are hot reloaded correctly.
- `main.js` and `styles.css` output 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 `twcss` class. Make sure your view/codeblock/whatever has this class to enable tw utility classes for its children.1. Replace the following words in all files to your liking:
- obsidian-vite
- Obsidian Vite
- ObsidianVite
2. Look over `/manifest.json` and adjust as needed.
3. Look over `/tsconfig.app.json`, `/vite.config.ts`, `/src/main.tsx` and 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!