From e8acd1dbfbfc84ac5f2ab05625de33c1f5073da3 Mon Sep 17 00:00:00 2001 From: Zef Hemel Date: Tue, 19 Dec 2023 16:33:38 +0100 Subject: [PATCH] Copy tweaks --- website/{PLUGS.md => Plugs.md} | 0 website/SilverBullet.md | 47 +++++++++++++++++----------------- 2 files changed, 23 insertions(+), 24 deletions(-) rename website/{PLUGS.md => Plugs.md} (100%) diff --git a/website/PLUGS.md b/website/Plugs.md similarity index 100% rename from website/PLUGS.md rename to website/Plugs.md diff --git a/website/SilverBullet.md b/website/SilverBullet.md index 1519be72..96521be7 100644 --- a/website/SilverBullet.md +++ b/website/SilverBullet.md @@ -1,7 +1,7 @@ # 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. -So yeah, it’s basically a somewhat geeky note taking application or personal wiki. +So yeah, SilverBullet is basically a somewhat geeky note taking application or 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. @@ -11,42 +11,47 @@ You may have been told there is _no such thing_ as a [silver bullet](https://en. You were told wrong. -# Links for the impatient -* [[Install]]: how to install and deploy SilverBullet -* [[Manual]]: how to use this thing +# 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. * 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) * 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! + * [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 the fancy, aspirational vision-y talk. What does this thing actually do, and how does it work? You know... features, we need a feature list! +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! -* SilverBullet runs in any modern browser (including mobile ones) as a [[PWA]] in two [[Client Modes]] (_online_ and _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. +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 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. -* Provides a platform for [end-user programming](https://www.inkandswitch.com/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]]. -* **Self-hosted**: you own your data. All content is stored as plain files in a folder on disk. 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. +* 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]]. +* **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. -To get a good feel of what SilverBullet is capable of, have a look at this (slightly out of date) introduction video. +To get a feel of what SilverBullet is capable of, have a look at this (always ever so slightly out of date) introduction video. ```embed url: https://youtu.be/BbNbZgOwB-Y ``` + # Try it Here’s the kicker: -==You are looking at a (more or less) operational copy of SilverBullet **right now**==. +==You are looking at a (more or less) operational copy of SilverBullet **right now**.== That’s right, **this very website is powered by SilverBullet itself**. 🤯 @@ -82,22 +87,16 @@ function helloWorld() { } ``` -or YAML: - -```yaml -name: SilverBullet -rating: 5 -``` - # 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]]. -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` 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]] ``` -Hover over that list, click the edit button to see the query that generates this view. + +Hover over that list and click the edit button to see the query that generates this view. And it’s not just pages that can be queried, there’s a large variety of queriable sources and you can define your own via tags. Examples include `task`s, `page`s, `tag`s, and `link`s. The sky is the limit. See [[Objects]] and [[Live Queries]] for more information. @@ -105,6 +104,6 @@ And it’s not just pages that can be queried, there’s a large variety of quer Has your mind been sufficiently blown to commit to an install? Took you long enough, alright then. Please proceed to [[Install]] and enjoy! # Support -If you (hypothetically) find bugs (we prefer to call them “features”) or have feature requests, post them in [our issue tracker](https://github.com/silverbulletmd/silverbullet/issues). Want to contribute? [Check out the code](https://github.com/silverbulletmd/silverbullet). +If you (hypothetically) find bugs or have feature requests, post them in [our issue tracker](https://github.com/silverbulletmd/silverbullet/issues). Want to contribute? [Check out the code](https://github.com/silverbulletmd/silverbullet). Want to chat with us? [Join our Discord](https://discord.gg/EvXbFucTxn)! \ No newline at end of file