https://github.com/mprojectscode/obsidian-thanks-plugin
https://github.com/mprojectscode/obsidian-thanks-plugin
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/mprojectscode/obsidian-thanks-plugin
- Owner: mProjectsCode
- License: mit
- Created: 2024-03-27T19:06:24.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T14:41:56.000Z (over 1 year ago)
- Last Synced: 2025-04-03T15:01:46.693Z (about 1 year ago)
- Language: TypeScript
- Size: 79.1 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Thanks!
>
Automatically star the Obsidian plugins _and themes_ that you use.
## Thank you
A love letter to [thanks.nvim](https://github.com/jsongerber/thanks.nvim).
---
old stuff here
## Setup
This uses [bun](https://bun.sh/), not node. So you need that installed. If you are on windows use WSL, if that does not work... good luck.
Things to change Checklist:
- [ ] `manifest.json`
- [ ] `package.json`
- [ ] `versions.json`
- [ ] `automation/config.js`
- [ ] `.github/workflows/release.yml`
- [ ] rename `exampleVault/.obsidian/lemons-plugin-template`
If and **only if** you completed these steps, you can run `bun install` and `bun run dev` to start your plugin jorney.
## Scripts Explained
- `dev` - build into the example vault with hot reload
- `build` - build for release
- `tsc` - run type checker
- `test` - run your tests
- `test:log` - run your tests with console output enabled
- `format` - format your code
- `format:check` - check the formatting of your code
- `lint` - lint your code
- `lint:fix` - lint your code and fix auto fixable mistakes
- `check` - check for formatting, linting, type errors and run the tests
- `check:fix` - fix formatting and linting errors, check for type errors and run the tests
- `release` - run the script to release a new version
## References
- Sample plugin repo: https://github.com/obsidianmd/obsidian-sample-plugin
- Obsidian help: https://help.obsidian.md/Home
- Obsidian docs: https://docs.obsidian.md/Home
- Obsidian API: https://github.com/obsidianmd/obsidian-api/blob/master/obsidian.d.ts