diff --git a/website/Desktop.md b/website/Desktop.md index f3183e16..225ccb08 100644 --- a/website/Desktop.md +++ b/website/Desktop.md @@ -10,12 +10,12 @@ Why would you want to install SilverBullet as a desktop application, as opposed 2. It auto updates (at least on Mac and Windows), so you don’t have to worry about upgrades. 3. It’s easier to open multiple spaces without having to fiddle manually with starting multiple [[Server]] instances on different ports. -Why would you _not_ want to use the Desktop version? You’re limited to only access your space on your desktop computer, whereas the [[Server]] simply exposes SilverBullet as a web server you can access from multiple devices. You can use [[Sync]] to work around this issue, however. +Why would you _not_ want to use the Desktop version? You’re limited to only accessing your space on your desktop computer, whereas the [[Server]] simply exposes SilverBullet as a web server you can access from multiple devices. You can use [[Sync]] to work around this issue, however. Convinced? [visit the releases page](https://github.com/silverbulletmd/silverbullet/releases) to go download it. ## How it works -What the SilverBullet desktop app technically does is spin up a SilverBullet [[Server]] locally on a random port, and then simply point a fancy looking window (with menus and stuff) at that local URL without all the usual browser chrome (hah, Chrome, funny). +What the SilverBullet desktop app technically does is spin up a SilverBullet [[Server]] locally on a random port, and then simply point a fancy-looking window (with menus and stuff) at that local URL without all the usual browser chrome (hah, Chrome, funny). What ships in the desktop package: diff --git a/website/Getting Started.md b/website/Getting Started.md index f74aa8e5..8afca8b3 100644 --- a/website/Getting Started.md +++ b/website/Getting Started.md @@ -56,4 +56,4 @@ Beyond that, you can find more information about SilverBullet on its official we 1. Through its [regular website link](https://silverbullet.md/) 2. Directly without leaving SilverBullet, through [[Cloud Links]], just click on this: [[SilverBullet]] (note that all of these will be read-only, for obvious reasons) -To keep up with the latest and greatest going-ons in SilverBullet land, keep an eye on the [[CHANGELOG]], regularly update your SilverBullet instance (`silverbullet upgrade` if you’re running the Deno version). If you run into any issues or have ideas on how to make SilverBullet even awesomer (yes, that’s a word), [join the conversation on GitHub](https://github.com/silverbulletmd/silverbullet). \ No newline at end of file +To keep up with the latest and greatest going-ons in SilverBullet land, keep an eye on the [[CHANGELOG]], and regularly update your SilverBullet instance (`silverbullet upgrade` if you’re running the Deno version). If you run into any issues or have ideas on how to make SilverBullet even awesomer (yes, that’s a word), [join the conversation on GitHub](https://github.com/silverbulletmd/silverbullet). \ No newline at end of file diff --git a/website/Sandbox.md b/website/Sandbox.md index bdb1b85c..cc167bf7 100644 --- a/website/Sandbox.md +++ b/website/Sandbox.md @@ -1,6 +1,6 @@ What does SilverBullet look like? Well, have a look around. **You’re looking at it at this very moment!** 🤯 -Note that what you’re looking at is not a fully functional version, because the _back-end is read-only_. That said, it should give you some feel for what it’s like to use SB before making the commitment of running a single `deno` command (see here: [[SilverBullet]]) to download and run it locally in its fully functioning mode. +Note that what you’re looking at is not a fully functional version because the _back-end is read-only_. That said, it should give you some feel for what it’s like to use SB before making the commitment of running a single `deno` command (see here: [[SilverBullet]]) to download and run it locally in its fully functioning mode. ## Start playing So, feel free to make some edits in this space. Don’t worry, you won’t break anything, nothing is saved (just reload the page to see). diff --git a/website/Sync.md b/website/Sync.md index f61726a4..028beff0 100644 --- a/website/Sync.md +++ b/website/Sync.md @@ -1,11 +1,11 @@ -SilverBullet now has a sync engine. It’s still early in its development, so somewhat experimental. If you decided to use it **make back-ups**. +SilverBullet now has a sync engine. It’s still early in its development, so somewhat experimental. If you decide to use it **make back-ups**. The synchronization algorithm implemented is [pretty much the one described here](https://unterwaditzer.net/2016/sync-algorithm.html). ## Architecture To use SilverBullet sync, you’ll use a single SilverBullet [[Server]] as your central synchronization space, then connect any other instances of SilverBullet (likely primarily [[Mobile]] and [[Desktop]] apps, but could also be other [[Server]] instances) to it. Each “client” instance keeps track of sync snapshots that it uses to figure out what files have changed where. -Let’s put this information in a graph, just because we can! +Let’s put this information in a graph just because we can! ```mermaid graph TD; @@ -18,7 +18,7 @@ graph TD; ## Usage Here’s how to use SilverBullet’s sync functionality: -1. Set up a SilverBullet [[Server]] somewhere where all your other devices have access to it. This can be your local network, a VPN, or if you’re living the wild life — the public Internet (do put some SSL and authentication on it please). +1. Set up a SilverBullet [[Server]] somewhere where all your other devices have access to it. This can be your local network, a VPN, or if you’re living the wild life — the public Internet (do put some SSL and authentication on it, please). 2. Connect any other SilverBullet instance (likely the [[Desktop]] or [[Mobile]] app) to it via the {[Sync: Configure]} command. This will ask for: * A URL to connect to (the URL of the SB server configured under (1)) * A username and password (optional) if you run the server with the `--user myuser:mypass` flag (as you should) @@ -33,14 +33,14 @@ Sync is triggered: * Manually using the {[Sync: Sync]} command (full space sync) ## The sync process -1. The sync engine compares two file listings: the local one and remote one, and figures out which files have been added, changed and removed on both ends. It uses timestamps to determine changes. Note this doesn’t make any assumptions about clocks being in sync, timezones etc. -2. In most cases, based on this info (together with the snapshot from the last sync) it should be obvious what to do, and it will do just do it. +1. The sync engine compares two file listings: the local one and the remote one, and figures out which files have been added, changed and removed on both ends. It uses timestamps to determine changes. Note this doesn’t make any assumptions about clocks being in sync, timezones etc. +2. In most cases, based on this info (together with the snapshot from the last sync), it should be obvious what to do, and it will do just do it. 3. In case of a conflict — which would happen if files on both ends have been changed since the last sync, it will first pull down both files and compare their content. If they’re the same, no issues. If they’re different: a conflicting copy will be created with a name of `page name.conflicted.timestamp`. You’ll see those appear in your page list. ## Caveats -* This is new code, and not been extremely thoroughly tested. Make backups. +* This is new code and has not been extremely thoroughly tested. Make backups. * The sync engine doesn’t synchronize `_plugs` code, so to update the plug list based on your [[PLUGS]] you have to manually run {[Plugs: Update]}. So, if you’re ready for this. Go try it. We do recommend: make regular backups in case the proverbial shit hits the fan, don’t say we didn’t warn you! -You can tweaks some things in sync, such as excluding certain prefix from sync. For this, see the [[SETTINGS]] documentation. \ No newline at end of file +You can tweak some things in sync, such as excluding certain prefixes from sync. For this, see the [[SETTINGS]] documentation. \ No newline at end of file