From 4759a20b23df9f079103688da73ad6c7c0d41695 Mon Sep 17 00:00:00 2001 From: Zef Hemel Date: Fri, 22 Dec 2023 19:17:16 +0100 Subject: [PATCH] More minor website copy tweaks --- cmd/server.ts | 3 +-- website/Plugs/Emoji.md | 2 +- website/SilverBullet.md | 26 +++++++++++--------------- 3 files changed, 13 insertions(+), 18 deletions(-) diff --git a/cmd/server.ts b/cmd/server.ts index 2d0ca2b4..4356acb7 100644 --- a/cmd/server.ts +++ b/cmd/server.ts @@ -67,8 +67,7 @@ export async function serveCommand( ); if (hostname === "127.0.0.1") { console.info( - `SilverBullet will only be available locally (via http://localhost:${port}). -To allow outside connections, pass -L 0.0.0.0 as a flag, and put a TLS terminator on top.`, + `SilverBullet will only be available locally, to allow outside connections, pass -L0.0.0.0 as a flag, and put a TLS terminator on top.`, ); } diff --git a/website/Plugs/Emoji.md b/website/Plugs/Emoji.md index bdfd6e93..b8bf921f 100644 --- a/website/Plugs/Emoji.md +++ b/website/Plugs/Emoji.md @@ -1,3 +1,3 @@ #plug -The Emoji plug provides support for auto-completion of the `:emoji:` style syntax. It currently has support for the [15.1 emoji unicode standard](https://emojipedia.org/emoji-15.1). \ No newline at end of file +The Emoji plug provides support for auto-completion of the `:emoji:` style syntax. It currently has support for the [15.1 emoji unicode standard](https://emojipedia.org/emoji-15.1). 🎉 \ No newline at end of file diff --git a/website/SilverBullet.md b/website/SilverBullet.md index 5dda116b..fc1d3aa5 100644 --- a/website/SilverBullet.md +++ b/website/SilverBullet.md @@ -1,11 +1,11 @@ # Introduction -SilverBullet aims to be a **workshop for the mind**: a creative [[Spaces|space]] where you collect, create and expand your personal knowledge, while also letting you constantly evolve the tools you use to do so. +SilverBullet aims to be a **workshop for the mind**: a creative [[Spaces|space]] where you collect, create and expand your personal knowledge, while simultaneously letting you evolve the tools you use to do so. -So yeah, SilverBullet is basically a somewhat geeky note taking application or personal wiki. +So yeah, SilverBullet is basically a geeky note taking application and personal wiki. While you _can_ use SilverBullet as just a note taking application that stores notes in plain [[Markdown]] files on disk; it becomes truly powerful in the hands of more technical power users. By leveraging [[Metadata]] annotations, its [[Objects]] infrastructure, [[Live Queries]] and [[Live Templates]], it becomes a powerful [[End-User Programming]] tool, enabling you to quickly develop various types of ad-hoc knowledge systems. -SilverBullet is implemented as an _open-source_, _self-hosted_, _offline-capable_ web application ([[PWA]]). In order to use it, you have to self host it: that is, you need to run the web server either on your own machine, somewhere on your network, or in the cloud somewhere. See our [[Install|installation instructions]]. +SilverBullet is _open source_ and implemented as an _offline-capable_ web application ([[PWA]]). In order to use it, you have to _self host_ it: that is, you need to run the web server either on your own machine, somewhere on your network, or in the cloud somewhere. See our [[Install|installation instructions]]. You may have been told there is _no such thing_ as a [silver bullet](https://en.wikipedia.org/wiki/Silver_bullet). @@ -14,32 +14,28 @@ You were told wrong. # Quick Links * [[Install]]: how to install and deploy SilverBullet. * [[Manual]]: how to use this thing. -* [[CHANGELOG]]: SilverBullet is in active development, so things change rapidly. Watch this to see what’s new and changed. +* [[CHANGELOG]]: we’re in active development, so things change rapidly, watch this page to keep up. * Development: - * [Roadmap](https://github.com/orgs/silverbulletmd/projects/2/views/1): currently planned features and priorities - * [Issues](https://github.com/silverbulletmd/silverbullet/issues): if you have ideas, or find bugs, please report them - * [Discussions](https://github.com/silverbulletmd/silverbullet/discussions) + * [Roadmap](https://github.com/orgs/silverbulletmd/projects/2/views/1): currently planned features and priorities. + * [Issues](https://github.com/silverbulletmd/silverbullet/issues): if you have ideas, or find bugs, please report them. + * [Discussions](https://github.com/silverbulletmd/silverbullet/discussions): got ideas for features or questions? Ask them here. * Socials: * [Mastodon](https://fosstodon.org/@silverbulletmd): follow SilverBullet development on [Mastodon](https://joinmastodon.org/) * [Discord](https://discord.gg/EvXbFucTxn): for more real-time support and discussion, join our Discord! # Features -Alright then. Beyond all that fancy, aspirational vision-y talk. What does this thing actually do, and how does it work? Just gimme a feature list already! - -Fine. - Some highlights: * SilverBullet runs in any modern browser (including mobile ones) as a [[PWA]] in two [[Client Modes]] ([[Client Modes$online|online]] and [[Client Modes$sync|synced]] mode), where the _synced mode_ enables **100% offline operation**, keeping a copy of content in the browser’s local ([IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)) database, syncing back to the server when a network connection is available. * SilverBullet provides an 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. * SilverBullet supports wiki-style **page linking** using the `[[page link]]` syntax. Incoming links are indexed and appear as [[Linked Mentions]] at the bottom of the pages linked to thereby providing _bi-directional linking_. -* SilverBullet allows you to be extra productive using its [[Templates]] mechanism. +* SilverBullet allows you to boost your writing/knowledge collection productivity using its various [[Templates]] mechanism. * SilverBullet is 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). * Run commands via their keyboard shortcuts or the **command palette** (triggered with `Cmd-/` or `Ctrl-/` on Linux and Windows). * Use [[Slash Commands]] to perform common text editing operations. * SilverBullet is a platform for [[End-User Programming]] through its support for [[Objects]], [[Live Queries]] and [[Live Templates]], allowing to make parts of your pages _dynamic_. -* Robust extension mechanism using [[Plugs]]. +* SilverBullet can be extended using [[Plugs]]. * **Self-hosted**: you own your data. All content is stored as plain files in a folder on disk (if you so choose). Back up, sync, edit, publish, script with any additional tools you like. * SilverBullet is free, [**open source**, MIT licensed](https://github.com/silverbulletmd/silverbullet) software. @@ -89,9 +85,9 @@ function helloWorld() { ``` # Beyond Markdown -Where things get _really_ interesting is when using features like [[Live Queries]] that allow you to query all types of [[Objects]] indexed based on the pages in your [[Spaces]]. +Where things get slightly more interesting is when using features like [[Live Queries]] that allow you to query all types of [[Objects]] indexed based on the pages in your [[Spaces]]. -Let’s explore this with a meta example of using this functionality for this very website. All pages in this space that represent a [[Plugs|plug]] are tagged with the `#plug` tag. Now, if we would want to render a list of all plugs in one place using the [[template/plug]] template, we can simply do this as follows: +Let’s explore this with a meta example of using this functionality for this very website. All pages in this space that represent a [[Plugs|plug]] are tagged with the `#plug` [[Tags|tag]]. Now, if we would want to render a list of all plugs in one place using the [[template/plug]] template, we can simply do this as follows: ```query plug render [[template/plug]]