mingzailao
/
silverbullet
mirror of https://github.com/silverbulletmd/silverbullet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More website tweaks

pull/138/head
Zef Hemel 2022-11-27 18:02:48 +01:00
parent da4027f4bc
commit f685061f1a
2 changed files with 35 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
website/Silver Bullet.md
View File

@ -1,21 +1,20 @@
Silver Bullet is extensible, [open source](https://github.com/silverbulletmd/silverbullet), **personal Silver Bullet is an extensible, [open source](https://github.com/silverbulletmd/silverbullet), **personal
knowledge management** software. Indeed, at the most basic level that translates to “a note-taking app with links.” However, Silver Bullet goes a beyond just that. knowledge management** application. Indeed, fundamentally that’s fancy talk for “a note-taking app with links.” However, Silver Bullet goes a bit beyond just that.
Let’s have a look at some of its features. Let’s have a look at some of its features.
## Features ## Features
* Runs in any modern browser (including mobile browsers) and is installable as a PWA. * Runs in any modern browser (including on mobile) and is installable as a [PWA](https://web.dev/progressive-web-apps/).
* Provides a distraction-free, enjoyable markdown writing experience using [[Live Preview|live preview]] that **reduces visual noise**, but still gives direct access to the underlying [[Markdown]] syntax. * Provides a enjoyable [[Markdown]] writing experience with a clean UI, rendering text using [[Live Preview|live preview]] further **reducing visual noise**, while still providing direct access to the underlying markdown syntax.
* Supports wiki-like page linking using the `[[page link]]` syntax, keeping links up-to-date when pages are renamed. * Supports wiki-style **page linking** using the `[[page link]]` syntax, even keeping links up-to-date when pages are renamed.
* Optimized for keyboard-based operation: * Optimized for **keyboard-based operation**:
* Quickly navigate between pages using the **page switcher** (triggered with `Cmd-k` on Mac or `Ctrl-k` on Linux and Windows). * Quickly navigate between pages using the **page switcher** (triggered with `Cmd-k` on Mac or `Ctrl-k` on Linux and Windows).
* Run commands via their keyboard shortcuts, or the **command palette** (triggered with `Cmd-/` or `Ctrl-/` on Linux and Windows). * Run commands via their keyboard shortcuts, or the **command palette** (triggered with `Cmd-/` or `Ctrl-/` on Linux and Windows).
* Use [[🔌 Core/Slash Commands|slash commands]] to perform common text editing operations. * Use [[🔌 Core/Slash Commands|slash commands]] to perform common text editing operations.
* Supports annotating pages with metadata (using [[Frontmatter]]). * Provides a platform for [end-user programming](https://www.inkandswitch.com/end-user-programming/) through its support for annotating pages with [[Frontmatter]] and [[🔌 Directive|directives]] (such as [[🔌 Directive/Query|#query]]), making parts of pages _dynamic_.
* Provides a platform for [End-user Programming](https://www.inkandswitch.com/end-user-programming/) through its support of [[🔌 Directive|directives]] (such as [[🔌 Directive/Query|#query]]), which make parts of pages _dynamic_.
* Experimental [[🔌 Collab|real-time collaboration support]]. * Experimental [[🔌 Collab|real-time collaboration support]].
* Robust extension mechanism using [[🔌 Plugs]] * Robust extension mechanism using [[🔌 Plugs]].
* Self hosted: you own your data. All content is stored as plain files in a folder on disk. Back up, sync, edit, script with any other tools you like. * **Self hosted**: you own your data. All content is stored as plain files in a folder on disk. Back up, sync, edit, publish, script with any additional tools you like.
* Silver Bullet is [open source, MIT licensed](https://github.com/silverbulletmd/silverbullet) software. * Silver Bullet is [open source, MIT licensed](https://github.com/silverbulletmd/silverbullet) software.
![Screencast screenshot](demo-video-screenshot.png) ![Screencast screenshot](demo-video-screenshot.png)
@ -28,7 +27,7 @@ Here’s the kicker:
That’s right, **this very website is powered by Silver Bullet itself**. 🤯 That’s right, **this very website is powered by Silver Bullet itself**. 🤯
On this site, everything is editable as in a regular copy of Silver Bullet, just none of it persists (the back-end is read-only). So, edit away, reload the page and everything resets. On this site, everything is editable just none of it persists (the back-end is read-only). So, edit away, reload the page and everything resets.
Don’t just sit there, try it! Don’t just sit there, try it!
@ -69,8 +68,8 @@ rating: 5
There are a few features you don’t get to fully experience in this environment, because they rely on a working back-end, such as: There are a few features you don’t get to fully experience in this environment, because they rely on a working back-end, such as:
* [[🔌 Directive|Directives]] are disabled, although you will see them being used across this site (they just don’t update their content dynamically). * Any edits you make and pages you add aren’t saved (kind of useful).
* Intelligent **page renaming**, automatically updating any pages that link to it. * [[🔌 Directive|Directives]] are disabled, although you will see them being used across this site (look for those `<!-- #query ... -->` and `<!-- /query -->` comments), they just don’t update their content dynamically.
* **Full text search**. * **Full text search**.
* **Extending** and updating SB’s functionality by installing additional [[🔌 Plugs]] (SB parlance for plug-ins) and writing your own. * **Extending** and updating SB’s functionality by installing additional [[🔌 Plugs]] (SB parlance for plug-ins) and writing your own.
@ -78,9 +77,9 @@ There are a few features you don’t get to fully experience in this environment
Click on the links below to explore various aspects of Silver Bullet more Click on the links below to explore various aspects of Silver Bullet more
in-depth: in-depth:
* [[CHANGELOG|What’s new?]] * [[CHANGELOG]]: What’s new?
* [[💡 Inspiration]]: some of the projects that inspired Silver Bullet
* [[🔌 Plugs]]: extensions available in Silver Bullet * [[🔌 Plugs]]: extensions available in Silver Bullet
* [[💡 Inspiration]]: some of the projects that inspired Silver Bullet
* [[🔨 Development]]: how to start hacking on Silver Bullet itself * [[🔨 Development]]: how to start hacking on Silver Bullet itself
## Installing Silver Bullet ## Installing Silver Bullet
@ -90,13 +89,13 @@ This consists of two steps (unless Deno is already installed:
2. Installing Silver Bullet itself 2. Installing Silver Bullet itself
### Install Silver Bullet ### Install Silver Bullet
With [Deno installed](https://deno.land/manual/getting_started/installation), run: With Deno installed, run:
```shell ```shell
deno install -f --name silverbullet -A --unstable https://get.silverbullet.md deno install -f --name silverbullet -A --unstable https://get.silverbullet.md
``` ```
This will install `silverbullet` into your `~/.deno/bin` folder (which should already be in your path if you followed the Deno install instructions). This will install `silverbullet` into your `~/.deno/bin` folder (which should already be in your `$PATH` if you followed the Deno install instructions).
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: 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:

38
website/🔌 Directive/Query.md
View File

@ -166,13 +166,13 @@ For the sake of simplicity, we will use the `page` data source and limit the res
**Result:** Okay, this is what we wanted but there is also information such as `perm`, `type` and `lastModified` that we don't need. **Result:** Okay, this is what we wanted but there is also information such as `perm`, `type` and `lastModified` that we don't need.
<!-- #query page where type = "plug" order by lastModified desc limit 5 --> <!-- #query page where type = "plug" order by lastModified desc limit 5 -->
|name |lastModified |contentType |size|perm|type|repo |author |share-support|uri | |name |lastModified |contentType |size|perm|type|repo |share-support|
|--|--|--|--|--|--|--|--|--|--| |--|--|--|--|--|--|--|--|
|🔌 Collab |1669389685597|text/markdown|2199|rw|plug|https://github.com/silverbulletmd/silverbullet |Silver Bullet Authors|true| | |🔌 Collab |1669545776517|text/markdown|2926|rw|plug|https://github.com/silverbulletmd/silverbullet|true|
|🔌 Share |1669389175835|text/markdown|702 |rw|plug|https://github.com/silverbulletmd/silverbullet |Silver Bullet Authors| | | |🔌 Tasks |1669536555227|text/markdown|1231|rw|plug|https://github.com/silverbulletmd/silverbullet| |
|🔌 Graph View|1669388320673|text/markdown|1042|rw|plug|https://github.com/bbroeksema/silverbullet-graphview |Bertjan Broeksema | |github:bbroeksema/silverbullet-graphview/graphview.plug.json| |🔌 Share |1669536545411|text/markdown|672 |rw|plug|https://github.com/silverbulletmd/silverbullet| |
|🔌 Github |1669387590823|text/markdown|2222|rw|plug|https://github.com/silverbulletmd/silverbullet-github|Zef Hemel |true|github:silverbulletmd/silverbullet-github/github.plug.json | |🔌 Markdown|1669536539800|text/markdown|268 |rw|plug|https://github.com/silverbulletmd/silverbullet|true|
|🔌 Markdown |1669387575305|text/markdown|298 |rw|plug|https://github.com/silverbulletmd/silverbullet |Silver Bullet Authors|true| | |🔌 Emoji |1669536531680|text/markdown|155 |rw|plug|https://github.com/silverbulletmd/silverbullet| |
<!-- /query --> <!-- /query -->
#### 6.3 Query to select only certain fields #### 6.3 Query to select only certain fields
@ -184,13 +184,13 @@ and `repo` columns and then sort by last modified time.
from a visual perspective. from a visual perspective.
<!-- #query page select name author repo uri where type = "plug" order by lastModified desc limit 5 --> <!-- #query page select name author repo uri where type = "plug" order by lastModified desc limit 5 -->
|name |author |repo |ri| |name |author|repo |ri|
|--|--|--|--| |-----------||----------------------------------------------||
|🔌 Collab |Silver Bullet Authors|https://github.com/silverbulletmd/silverbullet || |🔌 Collab ||https://github.com/silverbulletmd/silverbullet||
|🔌 Share |Silver Bullet Authors|https://github.com/silverbulletmd/silverbullet || |🔌 Tasks ||https://github.com/silverbulletmd/silverbullet||
|🔌 Graph View|Bertjan Broeksema |https://github.com/bbroeksema/silverbullet-graphview || |🔌 Share ||https://github.com/silverbulletmd/silverbullet||
|🔌 Github |Zef Hemel |https://github.com/silverbulletmd/silverbullet-github|| |🔌 Markdown||https://github.com/silverbulletmd/silverbullet||
|🔌 Markdown |Silver Bullet Authors|https://github.com/silverbulletmd/silverbullet || |🔌 Emoji ||https://github.com/silverbulletmd/silverbullet||
<!-- /query --> <!-- /query -->
#### 6.4 Display the data in a format defined by a template #### 6.4 Display the data in a format defined by a template
@ -200,11 +200,11 @@ from a visual perspective.
**Result:** Here you go. This is the result we would like to achieve 🎉. Did you see how I used `render` and `template/plug` in a query? 🚀 **Result:** Here you go. This is the result we would like to achieve 🎉. Did you see how I used `render` and `template/plug` in a query? 🚀
<!-- #query page select name author repo uri where type = "plug" order by lastModified desc limit 5 render [[template/plug]] --> <!-- #query page select name author repo uri where type = "plug" order by lastModified desc limit 5 render [[template/plug]] -->
* [[🔌 Collab]] by **Silver Bullet Authors** ([repo](https://github.com/silverbulletmd/silverbullet)) * [[🔌 Collab]]
* [[🔌 Share]] by **Silver Bullet Authors** ([repo](https://github.com/silverbulletmd/silverbullet)) * [[🔌 Tasks]]
* [[🔌 Graph View]] by **Bertjan Broeksema** ([repo](https://github.com/bbroeksema/silverbullet-graphview)) * [[🔌 Share]]
* [[🔌 Github]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-github)) * [[🔌 Markdown]]
* [[🔌 Markdown]] by **Silver Bullet Authors** ([repo](https://github.com/silverbulletmd/silverbullet)) * [[🔌 Emoji]]
<!-- /query --> <!-- /query -->
PS: You don't need to select only certain fields to use templates. Templates are PS: You don't need to select only certain fields to use templates. Templates are