Skip to content

Commit d6b7e5e

Browse files
committed
Plug development documentation updates
1 parent 8849f07 commit d6b7e5e

File tree

1 file changed

+3
-23
lines changed

1 file changed

+3
-23
lines changed

website/Plugs/Development.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,15 @@
33
44
The easiest way to get started is to click the “Use this template” on the [silverbullet-plug-template](https://github.com/silverbulletmd/silverbullet-plug-template) repo.
55

6-
Generally, every plug consists of a YAML manifest file named `yourplugname.plug.yaml`. This file defines all functions that form your plug. To be loadable by SilverBullet (or any PlugOS-based system for that matter), it needs to be compiled into a bundle (ending with `.plug.js`).
6+
Generally, every plug consists of a YAML manifest file named `yourplugname.plug.yaml`. This file defines all functions that form your plug. To be loadable by SilverBullet, it needs to be compiled into a bundle (ending with `.plug.js`).
77

8-
Generally, the way to do this is to run `silverbullet plug:compile` as follows:
9-
10-
```shell
11-
silverbullet plug:compile yourplugname.plug.yaml
12-
```
13-
14-
During development, you may want to compile plugs in debug mode, which will not minify them and generate source maps:
15-
16-
```shell
17-
silverbullet plug:compile --debug yourplugname.plug.yaml
18-
```
19-
20-
If you use the plug template, this command is wrapped in your `deno.jsonc` file, so you can just run either:
8+
For this you need to have [Deno](https://deno.com) installed, after which you can run the `deno task build` command specified in the plug template repo:
219

2210
```shell
2311
deno task build
2412
```
2513

26-
to build it once, or
27-
28-
```shell
29-
deno task watch
30-
```
31-
32-
to build it and rebuild it when files are changed. This will write a `yourplugname.plug.js` file into the same folder.
33-
34-
For development it’s easiest to simply copy the `.plug.js` file into your space’s `_plug/` folder:
14+
For development it’s easiest to simply copy the `.plug.js` file into your space’s `_plug/` folder after it’s built:
3515

3616
```shell
3717
cp myplug.plug.js ~/myspace/_plug/

0 commit comments

Comments
 (0)