1
0

Fix doc typos (#578)

This commit is contained in:
Jim Tittsler 2023-11-26 20:55:33 +09:00 committed by GitHub
parent e6f77b12af
commit ec10cc1e79
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 16 additions and 16 deletions

View File

@ -5,7 +5,7 @@ All API requests from the client will always set the `X-Sync-Mode` request heade
The API:
* `GET /index.json` will return a full listing of all files in your space including metadata like when the file was last modified, as well as permissions. This is primarily used for sync purposes with the client.
* `GET /*.*`: _Reads_ and returns the content of the file at the given path. This means that if you `GET /index.md` you will receive the content of your `index` page. If the the optional `X-Get-Meta` _request header_ is set, the server does not _need to_ return the body of the file (but it can). The `GET` _response_ will have a few additional SB-specific headers:
* `GET /*.*`: _Reads_ and returns the content of the file at the given path. This means that if you `GET /index.md` you will receive the content of your `index` page. If the optional `X-Get-Meta` _request header_ is set, the server does not _need to_ return the body of the file (but it can). The `GET` _response_ will have a few additional SB-specific headers:
* (optional) `X-Last-Modified` the last modified time of the file as a UNIX timestamp in ms since the epoch (as coming from `Data.now()`). This timestamp _has_ to match the `lastModified` listed for this file in `/index.json` otherwise syncing issues may occur. When this header is missing, frequent polling-based sync will be disabled for this file.
* (optional) `X-Created` the created time of the file as a UNIX timestamp in ms since the epoch (as coming from `Data.now()`).
* (optional) `X-Permission`: either `rw` or `ro` which will change whether the editor opens in read-only or edit mode. When missing, `ro` is assumed.

View File

@ -1,6 +1,6 @@
# Admonitions
Silverbullet supports [admonitions](https://github.com/community/community/discussions/16925) using Github syntax (`note` and `warning`).
Silverbullet supports [admonitions](https://github.com/community/community/discussions/16925) using GitHub syntax (`note` and `warning`).
> **note** This is a
> note admonition

View File

@ -1,4 +1,4 @@
The most straightforward way to add TLS on top of SilverBulet is to use use [Caddy](https://caddyserver.com/). Caddy can automatically provision an SSL certificate for you.
The most straightforward way to add TLS on top of SilverBulet is to use [Caddy](https://caddyserver.com/). Caddy can automatically provision an SSL certificate for you.
When youre deploying on a public server accessible to the Internet, you can do this as follows:
@ -6,7 +6,7 @@ When youre deploying on a public server accessible to the Internet, you can d
$ sudo caddy reverse-proxy --to :3000 --from yourdomain.com:443
```
If youre deploying on a local network and access your server via a VPN, this is a bit more tricky. The recommended setup here is to use [Tailscale](https://tailscale.com/) which now [supports TLS certificates for your VPN servers](https://tailscale.com/kb/1153/enabling-https/). Once you have this enabled, get a certificate via:
If youre deploying on a local network and accessing your server via a VPN, this is a bit more tricky. The recommended setup here is to use [Tailscale](https://tailscale.com/), which now [supports TLS certificates for your VPN servers](https://tailscale.com/kb/1153/enabling-https/). Once you have this enabled, get a certificate via:
```shell
$ tailscale cert yourserver.yourtsdomain.ts.net

View File

@ -2,12 +2,12 @@ Federation enables _browsing_, and _synchronizing_ (parts of) spaces outside of
This enables a few things:
* Linking and browsing publicly hosted SilverBullet spaces (or website adhering to its [[API]]). For instance the [[!silverbullet.md/CHANGELOG|SilverBullet CHANGELOG]] without leaving the comfort of your own SilverBullet client.
* Linking and browsing publicly hosted SilverBullet spaces (or websites adhering to its [[API]]). For instance the [[!silverbullet.md/CHANGELOG|SilverBullet CHANGELOG]] without leaving the comfort of your own SilverBullet client.
* Reusing content from externally hosted sources, such as:
* _Templates_, e.g. by federating with `silverbullet.md/template` will give you access to the example templates hosted there without manually copying and pasting them, and automatically pull in the latest version. So you can for instance use `render [[!silverbullet.md/template/page]]` to use the [[template/page]] template.
* _Templates_, e.g. by federating with `silverbullet.md/template` will give you access to the example templates hosted there without manually copying and pasting them and automatically pull in the latest version. So you can, for instance, use `render [[!silverbullet.md/template/page]]` to use the [[template/page]] template.
* _Data_: such as tasks, item, data hosted elsewhere that you want to query from your own space.
**Note:** Federation does not support authentication yet, so all federated spaces need to be unauthenticated and will be _read only_.
**Note:** Federation does not support authentication yet, so all federated spaces need to be unauthenticated and will be _read-only_.
## Browsing
Browsing other publicly hosted spaces is as simple as navigating to a page starting with `!` such as [[!silverbullet.md/CHANGELOG]].
@ -22,7 +22,7 @@ federate:
This will synchronize all content under `!silverbullet.md` with a `template` prefix (so all templates hosted there) locally.
Currently content can only be synchronized in read-only mode, so you can not edit the synchronized files. This will likely change in the future.
Currently, content can only be synchronized in read-only mode, so you can not edit the synchronized files. This will likely change in the future.
## Hosting
Tooling to make hosting public spaces is still work in progress.
Tooling to make hosting public spaces is still a work in progress.

View File

@ -139,4 +139,4 @@ You can configure SB with environment variables instead of flags, which is proba
* `SB_PORT`: Sets the port to listen to, e.g. `SB_PORT=1234`
* `SB_FOLDER`: Sets the folder to expose, e.g. `SB_FOLDER=/space`
* `SB_AUTH`: Loads an [[Authentication]] database from a (JSON encoded) string, e.g. `SB_AUTH=$(cat /path/to/.auth.json)`
* `SB_SYNC_ONLY`: Runs the server in a "dumb" space store only mode (not indexing content or keeping other state), e.g. `SB_SYNC_ONLY=1`. This will disable the Online [[Client Modes]] altogether (and not even show the sync icon in the top bar). Conceptually, [silverbullet.md](https://silverbullet.md) runs in this mode.
* `SB_SYNC_ONLY`: Runs the server in a "dumb" space store-only mode (not indexing content or keeping other state), e.g. `SB_SYNC_ONLY=1`. This will disable the Online [[Client Modes]] altogether (and not even show the sync icon in the top bar). Conceptually, [silverbullet.md](https://silverbullet.md) runs in this mode.

View File

@ -17,7 +17,7 @@ Unordered lists are created by prefixing a line with `*` or `-`. For instance:
Since this tool is called SilverBullet, we prefer you to use the `*` bullet (which will even appear in _silver_ — clever huh?).
Ordered lists are created by simply putting a number follow by a period at the beginning of a line:
Ordered lists are created by simply putting a number followed by a period at the beginning of a line:
1. This is the first item
2. This is the second item
@ -43,12 +43,12 @@ You can use block quotes by prefixing lines with `>`:
> — Yogi Berra
# Code
For the programmers among us, theres three ways to mark up code. If you want to write some code inline, you can use backticks: `this is code`. For long code snippets you can either use a four-space indent:
For the programmers among us, there are three ways to mark up code. If you want to write some code inline, you can use backticks: `this is code`. For long code snippets, you can either use a four-space indent:
This is code
And another line
Or (preferably) the triple-back tick notation, which also allows you to (optionally) specify a coding language:
or (preferably) the triple-back tick notation, which also allows you to (optionally) specify a coding language:
```javascript
function hello() {

View File

@ -1,4 +1,4 @@
Code widgets are a SilverBullet specific “extension” to [[Markdown]]. Technically, its not an extension — it just gives new meaning to markdowns native fenced code blocks — code blocks that start with a triple backtick, specifying a programming language.
Code widgets are a SilverBullet-specific “extension” to [[Markdown]]. Technically, its not an extension — it just gives new meaning to markdowns native fenced code blocks — code blocks that start with a triple backtick, specifying a programming language.
Currently, SilverBullet provides two code widgets as part of its built-in [[🔌 Plugs]]:
@ -19,13 +19,13 @@ url: https://silverbullet.md
height: 500
```
and a Youtube video:
and a YouTube video:
```embed
url: https://www.youtube.com/watch?v=VemS-cqAD5k
```
Note, there is specific support for youtube videos — it automatically will set width, height and replaces the URL with an embed URL.
Note, there is specific support for YouTube videos — it automatically sets the width and height, and replaces the URL with an embed URL.
The body of an `embed` block is written in [[YAML]] and supports the following attributes: