5.3 KiB
Silver Bullet
Silver Bullet (SB) is an extensible, open source personal knowledge
platform. At its core it’s a clean markdown-based writing/note taking
application that stores your pages (notes) as plain markdown files in a folder
referred to as a space. Pages can be cross-linked using the
[[link to other page]] syntax. This makes it a simple tool for
Personal Knowledge Management.
However, once you leverage its various extensions (called plugs) it can feel
more like a knowledge platform, allowing you to annotate, combine and query
your accumulated knowledge in creative ways specific to you.
For more in-depth information, an interactive demo, and links to more
background, check out the Silver Bullet website
(published from this repo’s website/ folder).
Or checkout these two videos:
- A Tour of some of Silver Bullet’s features — spoiler alert: it’s cool.
- A look the SilverBullet architecture — spoiler alert: it’s plugs all the way down.
Features
- Free and open source. Silver Bullet is MIT licensed.
- The truth is in the markdown. Silver Bullet doesn’t use proprietary file formats. It keeps its data as plain markdown files on disk. While SB uses a database for indexing and caching some indexes, all of that can be rebuilt from its markdown source at any time. If SB would ever go away, you can still read your pages with any text editor.
- One single, distraction free mode. SB doesn’t have a separate view and edit mode. It doesn’t have a “focus mode.” You’re always in focused edit mode, why wouldn’t you?
- Keyboard oriented. You can use SB fully using the keyboard, typin’ the keys.
- Extend it your way. SB is highly extensible with plugs, and you can customize it to your liking and your workflows.
Installing Silver Bullet
Silver Bullet is built using Deno. To install it, you will
need to have Deno installed (tested on 1.26 or later). If you have homebrew on a
Mac, this is just a single brew install deno away.
To run Silver Bullet create a folder for your pages (it can be empty, or be an
existing folder with .md files) and run the following command in your
terminal:
deno run -A --unstable https://get.silverbullet.md <pages-path>
However, because this command is not super easy to remember, you may install it as well:
deno install -f --name silverbullet -A --unstable https://get.silverbullet.md
This will create a silverbullet (feel free to replace silverbullet in this
command with whatever you like) alias in your ~/.deno/bin folder. Make sure
this path is in your PATH environment variable.
This allows you to install Silver Bullet simply as follows:
silverbullet <pages-path>
By default, SB will bind to port 3000, to use a different port use the
--port flag. By default SB doesn’t offer any sort of authentication, to add
basic password authentication, pass the --password flag.
Once downloaded and booted, SB will print out a URL to open SB in your browser (spoiler alert: by default this will be http://localhost:3000 ).
#protip: If you have a PWA enabled browser (like any browser based on Chromium) hit that little button right of the location bar to install SB, and give it its own window frame (sans location bar) and desktop/dock icon. At last the PWA has found its killer app.
Upgrading Silver Bullet
Simply run this:
deno cache --reload https://get.silverbullet.md
And restart Silver Bullet. You should be good to go.
Developing Silver Bullet
Silver Bullet is written in TypeScript and built on top of the excellent CodeMirror 6 editor component. Additional UI is built using React.js. ParcelJS is used to build both the front-end and back-end bundles. The server backend runs as a HTTP server on node.js using express.
To prepare the initial web and plug build run:
deno task build
For convenience, you can install plugons-bundle and silverbullet into your
~/.deno/bin folder:
deno task install
You can then run the server in “watch mode” (automatically restarting when you change source files) with:
deno task watch-server -- <PATH-TO-YOUR-SPACE>
After this initial build, it's convenient to run three commands in parallel (in separate terminals):
deno task watch-web
deno task watch-server -- <PATH-TO-YOUR-SPACE>
deno task watch-plugs
Feedback
If you (hypothetically) find bugs or have feature requests, post them in our issue tracker. Would you like to contribute? Check out the code, and the issue tracker as well for ideas on what to work on.