|
5 | 5 | 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. |
6 | 6 |
|
7 | 7 | Things to change Checklist: |
8 | | -- [ ] `manifest.json` |
9 | | -- [ ] `package.json` |
10 | | -- [ ] `versions.json` |
11 | | -- [ ] `automation/config.js` |
12 | | -- [ ] rename `exampleVault/.obsidian/lemons-plugin-template` |
| 8 | + |
| 9 | +- [ ] `manifest.json` |
| 10 | +- [ ] `package.json` |
| 11 | +- [ ] `versions.json` |
| 12 | +- [ ] `automation/config.js` |
| 13 | +- [ ] rename `exampleVault/.obsidian/lemons-plugin-template` |
13 | 14 |
|
14 | 15 | If and **only if** you completed these steps, you can run `bun install` and `bun run dev` to start your plugin jorney. |
15 | 16 |
|
16 | 17 | ## Scripts Explained |
17 | 18 |
|
18 | | -- `dev` - build into the example vault with hot reload |
19 | | -- `build` - build for release |
20 | | -- `test` - run your tests |
21 | | -- `format` - format your code |
22 | | -- `lint` - lint your code |
23 | | -- `lint:fix` - lint your code and fix auto fixable mistakes |
24 | | -- `release` - run the script to release a new version |
| 19 | +- `dev` - build into the example vault with hot reload |
| 20 | +- `build` - build for release |
| 21 | +- `test` - run your tests |
| 22 | +- `format` - format your code |
| 23 | +- `lint` - lint your code |
| 24 | +- `lint:fix` - lint your code and fix auto fixable mistakes |
| 25 | +- `release` - run the script to release a new version |
25 | 26 |
|
26 | 27 | ## References |
27 | 28 |
|
28 | | -Sample plugin repo: https://github.com/obsidianmd/obsidian-sample-plugin |
29 | | -Obsidian help: https://help.obsidian.md/Home |
30 | | -Obsidian docs: https://docs.obsidian.md/Home |
31 | | -Obsidian API: https://github.com/obsidianmd/obsidian-api/blob/master/obsidian.d.ts |
| 29 | +- Sample plugin repo: https://github.com/obsidianmd/obsidian-sample-plugin |
| 30 | +- Obsidian help: https://help.obsidian.md/Home |
| 31 | +- Obsidian docs: https://docs.obsidian.md/Home |
| 32 | +- Obsidian API: https://github.com/obsidianmd/obsidian-api/blob/master/obsidian.d.ts |
0 commit comments