1
0

Updated website copy

This commit is contained in:
Zef Hemel 2022-11-27 08:48:13 +01:00
parent 3b1802399a
commit a95ee41ddb
3 changed files with 33 additions and 5 deletions

3
website/Live Preview.md Normal file
View File

@ -0,0 +1,3 @@
Silver Bullet uses a “live preview” markdown editor. This mechanism is heavily inspired by [Obsidians live preview mode](https://help.obsidian.md/Live+preview+update).
It reduces visual noise by not constantly showing [[Markdown]] codes such as `[this is a link](https://to.some.url)`, only showing the underlying Markdown when the cursor is placed inside.

14
website/Markdown.md Normal file
View File

@ -0,0 +1,14 @@
Markdown is a plain text formatting system [originally developed by John Gruber](https://daringfireball.net/projects/markdown/). It has since been standardized into [CommonMark](https://commonmark.org/), which is what Silver Bullet uses (with some extensions).
Specifically, Silver Bullet supports the following extensions to common mark:
* [[Frontmatter]]
* Double-bracketed wiki links: `[[link to page]]`, optionally with aliases `[[link to page|alias]]`.
* Hashtags, e.g. `#mytag`.
* Command link syntax: `{[Stats: Show]}` rendered into a clickable button {[Stats: Show]}.
* [Tables](https://www.markdownguide.org/extended-syntax/#tables)
* [Fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks)
* [Task lists](https://www.markdownguide.org/extended-syntax/#task-lists)
* [Highlight](https://www.markdownguide.org/extended-syntax/#highlight)
* [Automatic URL linking](https://www.markdownguide.org/extended-syntax/#automatic-url-linking)
* Custom markdown extensions provided by plugs

View File

@ -1,7 +1,16 @@
Silver Bullet is extensible, [open source](https://github.com/silverbulletmd/silverbullet), **personal
knowledge management** software. Indeed, thats fancy language for “a note taking app with links.”
knowledge management** software. Indeed, thats fancy language for “a note taking app with links (and some other stuff).”
Besides providing a nice [markdown](https://en.wikipedia.org/wiki/Markdown) editing experience (with live preview), and the ability to cross-link pages using the `[[page link]]` format, it also enables annotating your content with additional metadata (using [[Frontmatter]]), which can then be queried using a query [[🔌 Directive]]. Silver Bullet is highly extensible, and a lot of its functionality is proved via [[🔌 Plugs]].
Silver Bullet provides:
* An enjoyable markdown writing experience using [[Live Preview|live preview]] that **reduces visual noise**, but still gives direct access to the underlying [[Markdown]] syntax.
* The ability to cross-link pages using the `[[page link]]` syntax, keeping these links automatically up-to-date as pages are renamed.
* Primarily keyboard-based operation:
* 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).
* Use [[🔌 Core/Slash Commands|slash commands]] to perform common text editing operations.
* The ability to annotate pages with metadata (using [[Frontmatter]]), which can be [[🔌 Directive/Query|queried]] to build partially dynamic pages.
* A robust extension mechanism using [[🔌 Plugs]]
Here is a screenshot of Silver Bullet in PWA mode (Silver Bullet can be installed as a PWA on Chromium-based browsers):
@ -18,9 +27,11 @@ But heres the kicker:
Thats right, this very website is powered by a quasi-read-only version of Silver Bullet itself. 🤯
Quasi-read-only because everything is editable as in a regular copy of Silver Bullet, just none of it persists (the back-end is read-only).
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).
## Try it out
So, dont just sit there...
## Try it out!
* Click on the page picker (folder tree) icon at the top right, or hit `Cmd-k` (Mac) or `Ctrl-k` (Linux and Windows) to open the **page switcher**. Type the name of a nonexistent 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 that not all commands will work in this mode).
* Select some text and hit `Alt-m` to ==highlight== it, or `Cmd-b` (Mac) or `Ctrl-b` to make it **bold**.
@ -58,7 +69,7 @@ rating: 5
There are a few [[🤯 Features]] you dont get to fully experience in this environment, because they rely on a working back-end, such as:
* Using Silver Bullet [[🔌 Directive]]s where part of pages are automatically rendered and kept up to date by querying various data sources (such as pages and their metadata, back links, tasks embedded in pages, and list items) with an SQL like syntax, rendered with handlebars templates.
* Using Silver Bullet [[🔌 Directive|directives]] where part of pages are automatically rendered and kept up to date by querying various data sources (such as pages and their metadata, back links, tasks embedded in pages, and list items) with an SQL like syntax, rendered with handlebars templates.
* Intelligent **page renaming**, automatically updating any pages that link to it.
* **Full text search**.
* **Extending** and updating SBs functionality by installing additional [[🔌 Plugs]] (SB parlance for plug-ins) and writing your own.