Skip to content

silverbulletmd/silverbullet-plug-template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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 Deno installed. Then, build the plug with:

deno task 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

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%