Switching website to live SB instance
parent
27a8adf347
commit
69ac54b414
|
@ -18,7 +18,7 @@ background, check out the [Silver Bullet website](https://silverbullet.md)
|
||||||
|
|
||||||
Or checkout these two videos:
|
Or checkout these two videos:
|
||||||
|
|
||||||
- [A Tour of some of Silver Bullet’s features](https://youtu.be/RYdc3UF9gok) —
|
- [A Tour of some of Silver Bullet’s features](https://youtu.be/VemS-cqAD5k) —
|
||||||
spoiler alert: it’s cool.
|
spoiler alert: it’s cool.
|
||||||
- [A look the SilverBullet architecture](https://youtu.be/mXCGau05p5o) — spoiler
|
- [A look the SilverBullet architecture](https://youtu.be/mXCGau05p5o) — spoiler
|
||||||
alert: it’s plugs all the way down.
|
alert: it’s plugs all the way down.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[build]
|
[build]
|
||||||
publish = "website_build"
|
publish = "website_build"
|
||||||
command = "./scripts/build_website.sh"
|
command = "./scripts/build_demo.sh"
|
||||||
|
|
||||||
[context.demo]
|
[context.demo]
|
||||||
command = "./scripts/build_demo.sh"
|
command = "./scripts/build_demo.sh"
|
||||||
|
|
|
@ -0,0 +1,21 @@
|
||||||
|
Frontmatter is a common format to attach additional meta data (data about data) to markdown documents.
|
||||||
|
|
||||||
|
You create it by starting your markdown document with `---` followed by [[YAML]] encoded attributes and then ending with `---` again. Followed by the regular body of your document.
|
||||||
|
|
||||||
|
Here is an example:
|
||||||
|
|
||||||
|
---
|
||||||
|
status: Draft
|
||||||
|
tags:
|
||||||
|
- tag1
|
||||||
|
- tag2
|
||||||
|
---
|
||||||
|
## This is a section
|
||||||
|
This is content
|
||||||
|
|
||||||
|
Silver Bullet allows arbitrary metadata to be added to pages this way, with two exceptions:
|
||||||
|
|
||||||
|
* `name` is an attribute used for page names, so don’t attempt to override it in frontmatter
|
||||||
|
* `tags` can be specified (as in the example) and are in effect another way of adding tags to your page, you can achieve the same result by simply adding hashtags in the body of your document, e.g. `#tag1 #tag2`.
|
||||||
|
|
||||||
|
Silver Bullet also has the _convention_ of using attributes starting with a `$` for internal use. For instance, the sharing capability uses the `$share` attribute, and `$disableDirectives: true` has the special meaning of disabling [[🔌 Directive]] processing on a page.
|
|
@ -1,8 +1,7 @@
|
||||||
## Markdown as a platform
|
Silver Bullet is extensible, [open source](https://github.com/silverbulletmd/silverbullet), **personal
|
||||||
Silver Bullet (SB) is highly-extensible, [open source](https://github.com/silverbulletmd/silverbullet) **personal
|
knowledge management** software. Indeed, that’s fancy language for “a note taking app with links.” Beside providing a nice [markdown](https://en.wikipedia.org/wiki/Markdown) editing experience (with live preview), it also enables annotating your content with additional metadata (using [[Frontmatter]]), which can then be queried using a query [[🔌 Directive]].
|
||||||
knowledge management** software. Indeed, that’s fancy language for “a note taking app with links.”
|
|
||||||
|
|
||||||
Here is a screenshot when installed as a PWA on desktop:
|
Here is a screenshot of Silver Bullet in PWA mode (Silver Bullet can be installed as a PWA on Chromium-based browsers):
|
||||||
|
|
||||||
![Silver Bullet PWA Screenshot](silverbullet-pwa.png)
|
![Silver Bullet PWA Screenshot](silverbullet-pwa.png)
|
||||||
|
|
||||||
|
@ -10,12 +9,67 @@ It also works in mobile browsers:
|
||||||
|
|
||||||
![Silver Bullet on mobile](silverbullet-ios.png)
|
![Silver Bullet on mobile](silverbullet-ios.png)
|
||||||
|
|
||||||
At its core, SB is a Markdown editor 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. 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. To get a good feel for it, [watch this video](https://youtu.be/RYdc3UF9gok).
|
|
||||||
|
|
||||||
And then, [give it a try in our Sandbox](https://demo.silverbullet.md/Sandbox).
|
But here’s the kicker:
|
||||||
|
|
||||||
## Explore more
|
==You are looking at a (more or less) operational copy of Silver Bullet **right now**==.
|
||||||
|
|
||||||
|
That’s 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.
|
||||||
|
|
||||||
|
## 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 won’t 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**.
|
||||||
|
* Click a link somewhere on this page to navigate there.
|
||||||
|
* Start typing `[[` somewhere to insert a page link (with completion).
|
||||||
|
* [ ] Tap this box 👈 to mark this task as done.
|
||||||
|
* Start typing `:party` to trigger the emoji picker 🎉
|
||||||
|
* Type `/` somewhere in the text to invoke a **slash command**.
|
||||||
|
* Hit `Cmd-p` (Mac) or `Ctrl-p` (Windows, Linux) to show a live preview for the current page on the side, if your brain doesn’t speak native Markdown yet.
|
||||||
|
* Open this site on your phone or tablet and… it just works!
|
||||||
|
* Are you using a browser with **PWA support** (e.g. any Chromium-based
|
||||||
|
browser)? Click on that little icon to the right of your location bar that says “Install Silver Bullet” to give SB its own window frame and desktop icon, like it is a stand-alone app (not particularly useful on silverbullet.md, but definitely do this once you install it yourself).
|
||||||
|
|
||||||
|
Oh yeah, you can use fancy things like tables:
|
||||||
|
|
||||||
|
| Page | Comment |
|
||||||
|
|----------|----------|
|
||||||
|
| [[Silver Bullet]] | Main product page |
|
||||||
|
| [[CHANGELOG]] | The latest updates |
|
||||||
|
|
||||||
|
or code snippets, like JavaScript:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
function helloWorld() {
|
||||||
|
return "Hello there!"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
or YAML:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Silver Bullet
|
||||||
|
rating: 5
|
||||||
|
```
|
||||||
|
|
||||||
|
Click into any of these and edit them.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
* 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.
|
||||||
|
* Intelligent **page renaming**, automatically updating any pages that link to it.
|
||||||
|
* **Full text search**.
|
||||||
|
* **Extending** and updating SB’s functionality by installing additional [[🔌 Plugs]] (SB parlance for plug-ins) and writing your own.
|
||||||
|
|
||||||
|
|
||||||
|
## Explain more, please
|
||||||
|
Silver Bullet is a Markdown editor 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. 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.
|
||||||
|
![Screencast screenshot](demo-video-screenshot.png)
|
||||||
|
Some things are just [better explained in a video](https://youtu.be/VemS-cqAD5k).
|
||||||
|
|
||||||
|
## Where to go from here
|
||||||
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:
|
||||||
|
|
||||||
|
@ -25,11 +79,6 @@ in-depth:
|
||||||
* [[🔌 Plugs]]
|
* [[🔌 Plugs]]
|
||||||
* [[🔨 Development]]
|
* [[🔨 Development]]
|
||||||
|
|
||||||
More of a video person? Here are two to get you started:
|
|
||||||
|
|
||||||
- [A Tour of Silver Bullet’s features](https://youtu.be/RYdc3UF9gok) — spoiler alert: it’s cool.
|
|
||||||
- [A look the SilverBullet architecture](https://youtu.be/mXCGau05p5o) — spoiler alert: it’s plugs all the way down.
|
|
||||||
|
|
||||||
## Principles
|
## Principles
|
||||||
Some core principles that underly Silver Bullet’s philosophy:
|
Some core principles that underly Silver Bullet’s philosophy:
|
||||||
|
|
||||||
|
@ -42,48 +91,30 @@ Some core principles that underly Silver Bullet’s philosophy:
|
||||||
## Installing Silver Bullet
|
## Installing Silver Bullet
|
||||||
This consists of two steps (unless Deno is already installed:
|
This consists of two steps (unless Deno is already installed:
|
||||||
|
|
||||||
1. Installing Deno
|
1. [Install Deno](https://deno.land/manual/getting_started/installation)
|
||||||
2. Installing Silver Bullet itself
|
2. Installing Silver Bullet itself
|
||||||
|
|
||||||
### Installing Deno
|
|
||||||
Silver Bullet is built using [Deno](https://deno.land). To install Deno on Linux or Mac run:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
curl -fsSL https://deno.land/install.sh | sh
|
|
||||||
```
|
|
||||||
|
|
||||||
This will install Deno into `~/.deno/bin`, add this folder to your `PATH` in your `~/.bashrc` or `~/.zshrc` file.
|
|
||||||
|
|
||||||
To install Deno on Windows (using Powershell) run:
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
irm https://deno.land/install.ps1 | iex
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install Silver Bullet
|
### Install Silver Bullet
|
||||||
With Deno installed, run:
|
With [Deno installed](https://deno.land/manual/getting_started/installation), 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 installed Deno following the previous 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:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
silverbullet <pages-path>
|
silverbullet <pages-path>
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, SB will bind to port `3000`, to use a different port use the
|
By default, Silver Bullet will bind to port `3000`, to use a different port use the the `--port` flag.
|
||||||
`--port` flag. By default SB doesn’t offer any sort of authentication, to add basic password authentication, pass the `--password` flag.
|
|
||||||
|
|
||||||
Once downloaded and booted, SB will print out a URL to open SB in your browser (spoiler alert: by default this will be http://localhost:3000 ).
|
Once downloaded and booted, Silver Bullet will print out a URL to open SB in your browser (spoiler alert: by default this will be http://localhost:3000 ).
|
||||||
|
|
||||||
#protip: If you have a PWA enabled browser (like any browser based on Chromium) hit that little button right of the location bar to install SB, and give it its own window frame (sans location bar) and desktop/dock icon. At last the PWA has found its killer app.
|
|
||||||
|
|
||||||
## Upgrading Silver Bullet
|
## Upgrading Silver Bullet
|
||||||
Simply run this:
|
Simply run:
|
||||||
|
|
||||||
silverbullet upgrade
|
silverbullet upgrade
|
||||||
|
|
||||||
|
@ -94,5 +125,4 @@ And restart Silver Bullet. You should be good to go.
|
||||||
If you upgraded to the new Deno-based Silver Bullet 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.
|
If you upgraded to the new Deno-based Silver Bullet 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.
|
||||||
|
|
||||||
If you (hypothetically) find bugs or have feature requests, post them in
|
If you (hypothetically) find bugs or have feature requests, post them in
|
||||||
[our issue tracker](https://github.com/silverbulletmd/silverbullet/issues). Want
|
[our issue tracker](https://github.com/silverbulletmd/silverbullet/issues). Want to contribute? [Check out the code](https://github.com/silverbulletmd/silverbullet).
|
||||||
to contribute? [Check out the code](https://github.com/silverbulletmd/silverbullet).
|
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
YAML stands for “YAML Ain’t Markup Language.” More information can be found at [the YAML website](https://yaml.org/).
|
||||||
|
|
||||||
|
Silver Bullet uses YAML in various contexts, specifically [[Frontmatter]].
|
Binary file not shown.
After Width: | Height: | Size: 61 KiB |
Binary file not shown.
Before Width: | Height: | Size: 271 KiB After Width: | Height: | Size: 140 KiB |
Loading…
Reference in New Issue