mirror of
https://github.com/lossless-group/image-gin.git
synced 2026-07-22 06:49:33 +00:00
improve(setup-script): improve setup script to hopefully work, unsure
yet On branch refactor/refactor-to-starter-code Changes to be committed: modified: README.md modified: package.json modified: setup-plugin.mjs
This commit is contained in:
parent
b20cc51d6c
commit
cac37d2ff5
3 changed files with 16 additions and 0 deletions
15
README.md
15
README.md
|
|
@ -4,6 +4,21 @@ # Obsidian Plugin Starter
|
|||
|
||||
## Getting Started
|
||||
|
||||
If you want to use the `setup-plugin.mjs` script, fill out `plugin-config.yaml` and then make it an executable file.
|
||||
|
||||
```bash
|
||||
chmod +x setup-plugin.mjs
|
||||
```
|
||||
|
||||
When run, it will create the basic metadata and fill in the template variables. If you don't need it, just delete it and happy hacking.
|
||||
|
||||
Run the script with
|
||||
|
||||
```bash
|
||||
node setup-plugin.mjs
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
pnpm install
|
||||
pnpm add -D esbuild @types/node builtin-modules
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@
|
|||
"description": "This is starter code for Obsidian plugins (https://obsidian.md)",
|
||||
"main": "main.js",
|
||||
"scripts": {
|
||||
"setup": "node setup-plugin.mjs",
|
||||
"dev": "node esbuild.config.mjs",
|
||||
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||
"version": "node version-bump.mjs && git add manifest.json versions.json"
|
||||
|
|
|
|||
0
setup-plugin.mjs
Normal file → Executable file
0
setup-plugin.mjs
Normal file → Executable file
Loading…
Reference in a new issue