Skip to content

About

Template for starting a new plug

Resources

Stars

22 stars

Watchers

1 watching

Forks

 
 

Latest commit

 

History

18 Commits

Folders and files

Repository files navigation

SilverBullet plug template

Insert your plug description here.

Development preparation

  1. In your (development) space, create a folder under Library/ that you can use as a namespace, for instance using your Github username:
mkdir -p ~/myspace/Library/you
  1. Symlink this plug's folder into your namespaced folder:
ln -s $PWD ~/myspace/Library/you/hello
  1. Update the name attribute in PLUG.md to match the location of that PLUG file in your space, and the file name of the destination .plug.js file as well e.g.
---
name: Library/you/hello/PLUG
tags: meta/library
files:
- myplug.plug.js
---

Build

To build this plug, make sure you have Node.js installed. Then, install dependencies and build the plug with:

npm install
npm run build

Within ~20s SilverBullet will automatically sync your plug code, just watch your browser's JavaScript console to see when this happens. Then run the Plugs: Reload command to reload and reactivate the plug (no reload required).

Distribution

  1. Commit the compiled .plug.js file to the repository
  2. Other people can now install your plug via the Library: Install command using the URL to your PLUG.md file as URI, e.g. https://github.com/silverbulletmd/silverbullet-plug-template/blob/main/PLUG.md

About

Template for starting a new plug

Resources

Stars

22 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages