https://github.com/swarnimarun/logseq-simple-plugin-starter
a decent & simple starter for logseq plugins (defaults to typescript)
https://github.com/swarnimarun/logseq-simple-plugin-starter
boilerplate logseq logseq-plugin simple starter template typescript vanilla
Last synced: 8 months ago
JSON representation
a decent & simple starter for logseq plugins (defaults to typescript)
- Host: GitHub
- URL: https://github.com/swarnimarun/logseq-simple-plugin-starter
- Owner: swarnimarun
- Created: 2022-12-10T20:49:24.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-10T23:32:24.000Z (about 3 years ago)
- Last Synced: 2023-03-22T10:02:55.282Z (almost 3 years ago)
- Topics: boilerplate, logseq, logseq-plugin, simple, starter, template, typescript, vanilla
- Language: TypeScript
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## logseq-simple-plugin-starter
A well setup vanilla-typescript logseq plugin development starter.
You can add other things on top of this if you know what you are doing but I would recommend using a specialized starter if your requirements are not:
- Very simple and light
- Quick setup and no-extras
- Using typescript
WHEN NOT TO USE THIS:
- You NEED entry point as a `index.html` (such as if it's a react app or something)
## USAGE
The project is pretty simple,
1. `index.ts` has the entry point and `helloworld.ts` shows how to modularize the code.
2. To run the code when developing, just do
```sh
npm run dev # or, pnpm dev
```
3. Above will watch your code for changes and you can reload the plugin in logseq to test it.
4. To get a production build, use
```sh
npm run build # or, pnpm build
# this will get you an optimized build
```
## FAQ
Feel free to let me know if I missed something, this was written purely because entire logseq ecosystem had a lack of proper starter templates for plugins and I needed one to write a quick plugin that I had in mind.
This is meant as a starter for things that are generally script only or don't require entire bloated frameworks, please don't ask me how to use it with anything like that.