Work on v2 launch content
This commit is contained in:
@@ -0,0 +1,38 @@
|
||||
I’m pleased to announce the release of SilverBullet v2, your next **open source**, **self hosted**, **programmable** notes application.
|
||||
|
||||
This release has _fewer features than ever_. Yes, you read that right. Rather than adding more complexity, in v2 we opted to [remove a whole slew of features](https://community.silverbullet.md/t/silverbullet-v2-the-path-forward/2036) developed as part of the 0.x series. These include online mode, query language, template language, command links, anchors, space script, space config, attribute extractors, object decorators, live embeds, federation and others.
|
||||
|
||||
A lot of these previously “baked in” features has now been reimagined on the unifying foundation of [[Space Lua]].
|
||||
|
||||
## What is SilverBullet
|
||||
If you’re new to SilverBullet, let’s back up a bit.
|
||||
|
||||
SilverBullet is a tool to **develop**, **organize**, and **structure** your personal knowledge and to make it **universally accessible** across all your devices.
|
||||
|
||||
In SilverBullet you keep your content as a collection of [[Markdown]] [[Pages]] (called a [[Spaces|Space]]). You navigate your space using the [[Page Picker]] like a traditional notes app, or through [[Links]] like a wiki (except they are [[Linked Mentions|bi-directional]]).
|
||||
|
||||
If you are the **writer** type, you’ll appreciate SilverBullet as a clean [[Markdown]] editor with [[Live Preview]]. If you have more of an **outliner** personality, SilverBullet has [[Outlines|Outlining]] tools for you. Productivity freak? Have a look at [[Tasks]].
|
||||
|
||||
More of a **database** person? You will appreciate [[Objects]] and [[Space Lua/Lua Integrated Query|Queries]].
|
||||
|
||||
And if you are comfortable (learning to) **program**, you will love dynamically generating content with [[Space Lua]] (SilverBullet’s [[Lua]] dialect), and use it to create custom [[Commands]] and [[Space Lua/Widgets]], and possibly use [[Space Style]] to personalize your Space’s look and feel.
|
||||
|
||||
SilverBullet is a **self-hosted web application**. You need to install it on a server. Perhaps you do this on a Raspberry Pi you didn’t have a use for, or a VPS somewhere in the cloud. SilverBullet is distributed as a single self-contained server [[Install/Binary]] or [[Install/Docker]] container. While this is a bit more complicated to set up than simply downloading a desktop or mobile app, since your space is centrally stored on a server under your control, you can now access it from anywhere you can access your server. And it may well be your gateway to [[Self Hosting]] more interesting applications.
|
||||
|
||||
${embed.youtube "https://www.youtube.com/watch?v=mik1EbTshX4"}
|
||||
## What’s new
|
||||
The biggest new feature in v2 is what was removed. The removal of features put extra pressure on coming up with new ways to rebuild old functionality, which in effect meant we really doubled down on [[Space Lua]] and greatly expanded its [[API]]s.
|
||||
|
||||
Features previously built as [[Plugs]] (in TypeScript) are now slowly being rebuilt as SilverBullet Lua [[Libraries]], and collected in [silverbullet-libaries](https://github.com/silverbulletmd/silverbullet-libraries) and [community forums](https://community.silverbullet.md/c/tricks-techniques/12).
|
||||
|
||||
What was previously known as “sync mode” is now the default and only mode in SilverBullet v2. This means that **all your content is continuously kept in sync** between your clients via your server, and all processing happens locally. No internet connection? No problem, you will have access to all your notes, can edit them and everything works the same as when online.
|
||||
|
||||
## Installing
|
||||
See the [[Install|installation options]].
|
||||
|
||||
## Upgrading
|
||||
If you’re a 0.x (“v1”) user, upgrading to v2 will be a breaking change due removed features. See the dedicated page on this topic: [[Migrate from v1]].
|
||||
|
||||
Therefore, be sure to backup before upgrading. Upgrading is as simple as following the [[Install|installation instructions]] and pointing at your existing [[Spaces|space folder]].
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
Some pointers on how to migrate from v1 to v2:
|
||||
[[2|SilverBullet v2]] removed a slew of features that were still present in the 0.x series (also known as “v1”). Sadly, we just had to rip the bandaid on this one.
|
||||
|
||||
Here are some pointers on what was removed and how to adapt.
|
||||
|
||||
# Queries
|
||||
v2 does not have support for old-style [queries](https://v1.silverbullet.md/Query%20Language) (live queries) anymore. They have been replaced with [[Space Lua/Lua Integrated Query]]. Give the linked page a read, but generally there’s a few differences:
|
||||
@@ -57,7 +59,6 @@ Certain features have been removed:
|
||||
* Online mode: v2 is sync mode only, meaning all your content will be synced into your browser. A simpler Online mode may be added back later. If you like to wipe your local content at any time, use the `System: Wipe Client` command.
|
||||
* [Federation](https://v1.silverbullet.md/Federation)
|
||||
* [Share](https://v1.silverbullet.md/Plugs/Share) replaced by [[^Library/Std/Export]]
|
||||
* [Libraries](https://v1.silverbullet.md/Libraries): will likely be replaced by [[^Library/Std/Import]].
|
||||
* Space Script: replaced by [[Space Lua]]
|
||||
* Space Config: replaced by the [[API/config]] APIs.
|
||||
* Command link syntax (`{[...]})`) replaced by the `${widgets.commandButton(...)}` API.
|
||||
|
||||
@@ -129,11 +129,9 @@ There's a magic `_CTX` global variable available from which you can access usefu
|
||||
* `_CTX._GLOBAL` providing access to the global scope
|
||||
|
||||
# API
|
||||
|
||||
![[API]]
|
||||
|
||||
# Lua implementation notes
|
||||
|
||||
Space Lua is intended to be a more or less complete implementation of [Lua 5.4](https://www.lua.org/manual/5.4/). However, a few features are (still) missing:
|
||||
|
||||
* `goto` and labels (not planned, goto considered harmful)
|
||||
@@ -143,11 +141,8 @@ Space Lua is intended to be a more or less complete implementation of [Lua 5.4](
|
||||
* Hexadecimal numeric constants with a fractional part, or binary exponents (not supported by JavaScript number parser either)
|
||||
|
||||
# Frequently Asked Questions
|
||||
|
||||
## Why Lua?
|
||||
|
||||
Lua is purpose-designed to be a simple, [easy to learn](https://www.lua.org/manual/5.4/), yet powerful language for extending existing applications. It is commonly used in the gaming industry, but to extend many other applications. If you know any other programming language, you will be able to learn Lua within hours or less.
|
||||
|
||||
## Why a custom Lua runtime?
|
||||
|
||||
Rather than using a WebAssembly or other implementation of Lua that could run in the browser and server, we have opted for a custom implementation. This is achievable because Lua is a relatively simple and small language to implement and allows for deep integration in the custom Lua runtime. The thing that triggered a custom implementation was the need to call asynchronous (JavaScipt) APIs from Lua, without having to resort to ugly asynchronous callback-style API design (Lua does not support async-await). In SilverBullet’s Lua implementation, the differences between asynchronous and synchronous APIs is fully abstracted away, which makes for a very clean development experience.
|
||||
|
||||
Reference in New Issue
Block a user