1
0
Workshop for the mind
Go to file
2023-05-24 06:47:39 +02:00
.github/workflows SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
.vscode Disable markdown auto format 2022-11-01 15:01:10 +01:00
cmd Allow configuring the port and folder to be configured with env variables 2023-05-24 05:42:02 +02:00
common SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
images New screenshots 2022-08-01 12:07:02 +02:00
plug-api SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
plugos SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
plugs SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
scripts SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
server Dispatch pageLoaded event upon plug updates 2023-05-24 06:47:39 +02:00
web Dispatch pageLoaded event upon plug updates 2023-05-24 06:47:39 +02:00
website Deno deploy instructions 2023-05-24 06:11:52 +02:00
.dockerignore SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
.env Update .env 2022-07-18 19:48:58 +02:00
.gitignore SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
.gitpod.Dockerfile Install specific Deno version, not just latest 2023-05-07 13:28:45 +02:00
.gitpod.yml New silverbullet command line structure, allowing for sub-commands 2022-10-23 09:06:12 +02:00
build_bundle.ts SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
build_plugs.ts SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
build_web.ts SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
CHANGELOG.md Work on #10 theming 2022-08-02 14:40:04 +02:00
deno.jsonc SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
docker-compose.yaml Minor change in docker compose to BasicAuth (#211) 2022-12-18 20:18:13 +01:00
Dockerfile SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
Dockerfile.s3 SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
import_map.json SilverBullet pivot to become an offline-first PWA (#403) 2023-05-23 20:53:53 +02:00
LICENSE.md Refactor of asset bundles 2022-10-12 11:47:13 +02:00
netlify.toml Another netlify try 2023-01-26 12:13:06 +01:00
package-lock.json Netlify build 2023-01-26 12:23:57 +01:00
package.json Netlify build 2023-01-26 12:23:57 +01:00
README.md README: running typechecker and unit tests (#389) 2023-04-18 20:56:47 +02:00
silverbullet.ts Allow configuring the port and folder to be configured with env variables 2023-05-24 05:42:02 +02:00
test_deps.ts Dependency bump 2022-11-19 16:05:37 +01:00
version.ts 0.3.1 2023-05-23 20:54:58 +02:00

SilverBullet

SilverBullet is an extensible, open source personal knowledge platform. At its core its 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 SilverBullet website (published from this repos website/ folder).

Or checkout these two videos:

Features

  • Free and open source. SilverBullet is MIT licensed.
  • The truth is in the markdown. SilverBullet doesnt 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 doesnt have a separate view and edit mode. It doesnt have a “focus mode.” Youre always in focused edit mode, why wouldnt 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 SilverBullet

Check out the official website

Troubleshooting

If you upgraded to the new Deno-based SilverBullet from an old version, you may have to use the silverbullet fix <pages-path> command to flush out your old database and plugs. Plugs will likely need to be updated.

Developing SilverBullet

Open in Gitpod

SilverBullet is written in TypeScript and built on top of the excellent CodeMirror 6 editor component. Additional UI is built using Preact. ESBuild is used to build both the front-end and back-end bundles. The server backend runs as a HTTP server on Deno using and is written using Oak.

To prepare the initial web and plug build run:

deno task build

To symlink silverbullet to your locally checked-out version, run:

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

To typecheck the entire codebase (recommended before submitting PR):

deno task check

To run unit tests:

deno task test

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.