https://github.com/pengx17/logseq-plugin-template-react
Logseq plugin boilerplate for React. Powered by Vite ✨
https://github.com/pengx17/logseq-plugin-template-react
logseq logseq-plugin react vitejs windicss
Last synced: 6 months ago
JSON representation
Logseq plugin boilerplate for React. Powered by Vite ✨
- Host: GitHub
- URL: https://github.com/pengx17/logseq-plugin-template-react
- Owner: pengx17
- Created: 2021-05-24T06:33:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-03T18:37:38.000Z (6 months ago)
- Last Synced: 2025-04-04T15:05:58.505Z (6 months ago)
- Topics: logseq, logseq-plugin, react, vitejs, windicss
- Language: TypeScript
- Homepage:
- Size: 1.17 MB
- Stars: 128
- Watchers: 1
- Forks: 18
- Open Issues: 13
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Logseq Plugin Template React 🚀
## Features
- Plug-and-play boilerplate with properly defined GitHub action defaults
- Develop with HMR, empowered by lightning-fast Vite ⚡ with [vite-logseq-plugin](https://github.com/pengx17/vite-plugin-logseq)
- TailwindCSS for styling
- Pnpm
## How to get started
1. Clone the repository or use the button "Use this template" on GitHub to create your own version of the repository 🔨
2. Make sure you have pnpm installed, [install](https://pnpm.io/installation) if necessary 🛠
3. Execute `pnpm install` 📦
4. Change the plugin-name in `package.json` to your liking. Adapt both the package-name and the plugin-id at the bottom of the `package.json`. Make sure that they are not conflicting with plugins you already installed. 📝
5. Execute `pnpm build` to build the plugin 🚧
6. Enable developer-mode in Logseq, go to plugins, select "Load unpacked plugin" 🔌
7. Select the directory of your plugin (not the `/dist`-directory, but the directory which includes your package.json) 📂
8. Enjoy! 🎉