1
0
silverbullet/website/index.md
2022-07-15 19:14:55 +02:00

3.2 KiB
Raw Blame History

Silver Bullet

Markdown as a platform

Silver Bullet (SB) is a highly extensible, open source personal knowledge playground. At its core its a Markdown-based writing/note taking application that stores 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 playground, allowing you to annotate, combine and query your accumulated knowledge in creative ways, specific to you.

What does Silver Bullet look like? Well, have a look around. Youre looking at it at this very moment! Say what!?

Feel free to make some edits, to get a feel for it. Dont worry, you wont break anything, nothing is saved (just reload the page to see).

Things to try:

  • Click on the page name at the top, or hit Cmd-k (Mac) or Ctrl-k (Linux and Windows) to open the page switcher. Type the a name of a non-existing page to create it (although it wont save in this environment).
  • Click on the run button (top right) or hit Cmd-/ (Mac) or Ctrl-/ (Linux and Windows) to open the command palette (note not all command will work in this quasi read-only mode).
  • Select some text and hit Alt-m to highlight it, or Cmd-b (Mac) or Ctrl-b to make it bold.
  • Click a link below to navigate there
  • Start typing [[ somewhere to insert a page link (with completion)
  • Tap this box 👈 to mark this task as done
  • Start typing :pa to trigger the emoji picker 🎉
  • Type / somewhere in the text to use a slash command.
  • Open this site on your phone or tablet and… it just works!

Explore more

Click on the links below to explore various of Silver Bullet more in-depth:

🤯 Features 💡 Inspiration 🔌 Plugs 🔨 Development 🗺 Roadmap

More of a video person? Heres two to get you started:

Installing and running Silver Bullet

Like what youre seeing? Install it yourself locally or on your server! Its free.

To run a release version, you need to have a recent version of node.js installed (16+) as well as some basic build infrastructure (make, cpp). Silver Bullet has only been tested on MacOS and Linux thus far.

To install and run, create a folder for your pages (can be empty or an existing folder with .md files) and run:

npx @silverbullet/server <path-to-folder>

Optionally you can use the --port argument to specify a HTTP port (defaults to 3000) and you can pass a --password flag to require a password to access. Note this is a rather weak security mechanism, so its recommended to add additional layers of security on top of this if you run this on a public server somewhere (at least add TLS). Personally I run it on a tiny Linux VM on my server at home, and use a VPN (Tailscale) to access it from outside my home.