diff --git a/README.md b/README.md index 20aa43ac..ecd4fdbd 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ Silver Bullet (SB) is a highly extensible, open source **personal knowledge play So what is it SB _really_? That is hard to answer. It can do a ton of stuff out of the box, and I’m constantly finding new use cases. It’s like... a silver bullet! +Below is what it looks like in action (when run on the `docs` folder in this repo). + ![Screenshot](https://raw.githubusercontent.com/zefhemel/silverbullet/main/images/silverbullet1.png) Here’s how I use it today (but this has grown significantly over time): @@ -37,7 +39,7 @@ To run a release version, you need to have a recent version of npm (8+) and node 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 + npx @silverbulletmd/server 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 it’s 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. ## Stack diff --git a/package-lock.json b/package-lock.json index a1910d59..1b0bb9f7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,7 +6,6 @@ "packages": { "": { "name": "silverbulletmd", - "version": "0.0.1", "license": "MIT", "workspaces": [ "packages/*" @@ -17683,7 +17682,7 @@ }, "packages/common": { "name": "@silverbulletmd/common", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { "@codemirror/autocomplete": "6.0.1", @@ -17698,9 +17697,9 @@ "@lezer/common": "1.0.0", "@lezer/highlight": "1.0.0", "@lezer/markdown": "1.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" } }, @@ -17711,13 +17710,13 @@ }, "packages/plugos": { "name": "@plugos/plugos", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { "@jest/globals": "^27.5.1", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "@types/cors": "^2.8.12", "@types/express": "^4.17.13", "@types/jsonwebtoken": "^8.5.8", @@ -17771,23 +17770,23 @@ }, "packages/plugos-silverbullet-syscall": { "name": "@silverbulletmd/plugos-silverbullet-syscall", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" } }, "packages/plugos-syscall": { "name": "@plugos/plugos-syscall", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" } }, @@ -19151,7 +19150,7 @@ }, "packages/plugs": { "name": "@silverbulletmd/plugs", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { "@jest/globals": "^27.5.1", @@ -19159,9 +19158,9 @@ "@lezer/lr": "1.0.0", "@mattermost/client": "^7.0.0", "@mattermost/types": "^7.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "@types/yaml": "^1.9.7", "handlebars": "^4.7.7", "markdown-it": "^12.3.2", @@ -19195,7 +19194,7 @@ }, "packages/server": { "name": "@silverbulletmd/server", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { "@codemirror/lang-javascript": "6.0.0", @@ -19203,9 +19202,9 @@ "@codemirror/legacy-modes": "6.0.0", "@jest/globals": "^27.5.1", "@lezer/markdown": "1.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "better-sqlite3": "^7.5.0", "body-parser": "^1.19.2", "buffer": "^6.0.3", @@ -20302,7 +20301,7 @@ }, "packages/web": { "name": "@silverbulletmd/web", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { "@codemirror/autocomplete": "6.0.1", @@ -20320,9 +20319,9 @@ "@jest/globals": "^27.5.1", "@lezer/highlight": "1.0.0", "@lezer/markdown": "1.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "fake-indexeddb": "^3.1.7", "fuzzysort": "^1.9.0", "jest": "^27.5.1", @@ -26769,9 +26768,9 @@ "@parcel/transformer-sass": "2.5.0", "@parcel/transformer-webmanifest": "2.5.0", "@parcel/validator-typescript": "2.5.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "@types/cors": "^2.8.12", "@types/events": "^3.0.0", "@types/express": "^4.17.13", @@ -27660,9 +27659,9 @@ "@plugos/plugos-syscall": { "version": "file:packages/plugos-syscall", "requires": { - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" } }, @@ -27681,9 +27680,9 @@ "@lezer/common": "1.0.0", "@lezer/highlight": "1.0.0", "@lezer/markdown": "1.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" }, "dependencies": { @@ -27697,9 +27696,9 @@ "@silverbulletmd/plugos-silverbullet-syscall": { "version": "file:packages/plugos-silverbullet-syscall", "requires": { - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" } }, @@ -27711,9 +27710,9 @@ "@lezer/lr": "1.0.0", "@mattermost/client": "^7.0.0", "@mattermost/types": "^7.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "@types/markdown-it": "^12.2.3", "@types/yaml": "^1.9.7", "handlebars": "^4.7.7", @@ -27755,9 +27754,9 @@ "@parcel/transformer-sass": "2.5.0", "@parcel/transformer-webmanifest": "2.5.0", "@parcel/validator-typescript": "2.5.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "@types/cors": "^2.8.12", "@types/events": "^3.0.0", "@types/express": "^4.17.13", @@ -28465,9 +28464,9 @@ "@parcel/transformer-sass": "2.5.0", "@parcel/transformer-webmanifest": "2.5.0", "@parcel/validator-typescript": "2.5.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "@types/cors": "^2.8.12", "@types/events": "^3.0.0", "@types/jest": "^27.4.1", diff --git a/packages/common/package.json b/packages/common/package.json index fdca6d6a..b1d2db77 100644 --- a/packages/common/package.json +++ b/packages/common/package.json @@ -4,7 +4,7 @@ "name": "Zef Hemel", "email": "zef@zef.me" }, - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { "@codemirror/autocomplete": "6.0.1", @@ -19,9 +19,9 @@ "@lezer/common": "1.0.0", "@lezer/highlight": "1.0.0", "@lezer/markdown": "1.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" } } diff --git a/packages/plugos-silverbullet-syscall/package.json b/packages/plugos-silverbullet-syscall/package.json index e82757eb..4b2c5367 100644 --- a/packages/plugos-silverbullet-syscall/package.json +++ b/packages/plugos-silverbullet-syscall/package.json @@ -4,12 +4,12 @@ "name": "Zef Hemel", "email": "zef@zef.me" }, - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" } } diff --git a/packages/plugos-syscall/package.json b/packages/plugos-syscall/package.json index 35b4621d..ed578671 100644 --- a/packages/plugos-syscall/package.json +++ b/packages/plugos-syscall/package.json @@ -4,12 +4,12 @@ "name": "Zef Hemel", "email": "zef@zef.me" }, - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "server": "^1.0.37" } } diff --git a/packages/plugos/package.json b/packages/plugos/package.json index ba72ef8f..aae28d7d 100644 --- a/packages/plugos/package.json +++ b/packages/plugos/package.json @@ -4,7 +4,7 @@ "name": "Zef Hemel", "email": "zef@zef.me" }, - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "bin": { "plugos-bundle": "./dist/plugos/plugos-bundle.js", @@ -40,9 +40,9 @@ }, "dependencies": { "@jest/globals": "^27.5.1", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "@types/cors": "^2.8.12", "@types/express": "^4.17.13", "@types/jsonwebtoken": "^8.5.8", diff --git a/packages/plugs/package-lock.json b/packages/plugs/package-lock.json index a1be3e6c..edf8327e 100644 --- a/packages/plugs/package-lock.json +++ b/packages/plugs/package-lock.json @@ -1,12 +1,12 @@ { "name": "@silverbulletmd/plugs", - "version": "0.0.7", + "version": "0.0.8", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@silverbulletmd/plugs", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "dependencies": { "@jest/globals": "^27.5.1", diff --git a/packages/plugs/package.json b/packages/plugs/package.json index e271fa79..646657ec 100644 --- a/packages/plugs/package.json +++ b/packages/plugs/package.json @@ -4,7 +4,7 @@ "name": "Zef Hemel", "email": "zef@zef.me" }, - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "scripts": { "generate": "lezer-generator query/query.grammar -o query/parse-query.js", @@ -36,9 +36,9 @@ "@lezer/lr": "1.0.0", "@mattermost/client": "^7.0.0", "@mattermost/types": "^7.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "@types/yaml": "^1.9.7", "handlebars": "^4.7.7", "markdown-it": "^12.3.2", diff --git a/packages/server/package.json b/packages/server/package.json index e55a55b8..53d4427d 100644 --- a/packages/server/package.json +++ b/packages/server/package.json @@ -4,7 +4,7 @@ "name": "Zef Hemel", "email": "zef@zef.me" }, - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "bin": { "silverbullet": "./dist/server/server.js" @@ -41,9 +41,9 @@ "@codemirror/legacy-modes": "6.0.0", "@jest/globals": "^27.5.1", "@lezer/markdown": "1.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "better-sqlite3": "^7.5.0", "body-parser": "^1.19.2", "buffer": "^6.0.3", diff --git a/packages/web/package.json b/packages/web/package.json index 4e4b3bc7..12cdb3df 100644 --- a/packages/web/package.json +++ b/packages/web/package.json @@ -4,7 +4,7 @@ "name": "Zef Hemel", "email": "zef@zef.me" }, - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "scripts": { "watch": "rm -rf .parcel-cache && parcel watch", @@ -41,9 +41,9 @@ "@jest/globals": "^27.5.1", "@lezer/highlight": "1.0.0", "@lezer/markdown": "1.0.0", - "@silverbulletmd/common": "^0.0.7", - "@silverbulletmd/plugs": "^0.0.7", - "@silverbulletmd/web": "^0.0.7", + "@silverbulletmd/common": "^0.0.8", + "@silverbulletmd/plugs": "^0.0.8", + "@silverbulletmd/web": "^0.0.8", "fake-indexeddb": "^3.1.7", "fuzzysort": "^1.9.0", "jest": "^27.5.1",