1
0
silverbullet/website/CHANGELOG.md

153 lines
13 KiB
Markdown
Raw Normal View History

2022-11-27 07:48:01 +00:00
An attempt at documenting the changes/new features introduced in each
2022-10-12 09:47:13 +00:00
release.
2022-08-01 09:25:46 +00:00
2024-01-02 13:53:17 +00:00
---
## Next
_Not yet released, this will likely become 0.6.0._
* **Directives have now been removed** from the code base. Please use [[Live Queries]] and [[Live Templates]] instead. If you hadnt migrated yet and want to auto migrate, downgrade your SilverBullet version to 0.5.11 (e.g. using the `zefhemel/silverbullet:0.5.11` docker image) and run the {[Directive: Convert Entire Space to Live/Templates]} command with that version.
* (Hopefully subtle) **breaking change** in how tags work (see [[Objects]]):
* Every object now has a `tag` attribute, signifying the “main” tag for that object (e.g. `page`, `item`)
* The `tags` attribute will now _only_ contain explicitly assigned tags (so not the built-in tag, which moved to `tag`)
* The new `itags` attribute (available in many objects) includes both the `tag`, `tags` as well as any tags inherited from the page the object appears in.
* Page tags now no longer need to appear at the top of the page, but can appear anywhere as long as they are the only thing appearing in a paragraph with no additional text, see [[Objects$page]].
* New [[Markdown/Code Widgets|Code Widget]]: `toc` to manually include a [[Table of Contents]]
* New template type: [[Live Template Widgets]] allowing you to automatically add templates to the top or bottom of your pages (based on some criteria). Using this feature it possible to implement [[Table of Contents]] and [[Linked Mentions]] without having “hard coded” into SilverBullet itself.
* **“Breaking” change:** Two features are now no longer hardcoded into SilverBullet, but can be activated quite easily using [[Live Template Widgets]] (see their respective documentation pages on instructions on how to do this):
* [[Table of Contents]]
* [[Linked Mentions]]
2024-01-15 15:52:27 +00:00
* Filter list (used by [[Page Picker]] and [[Command Palette]]) improvements:
* Better ranking
* Better positioning of modal (especially on mobile)
* Better mouse behavior
* Templates:
* Somewhat nicer rendering of {{templateVars}} (notice the gray background)
* Rendering of [[Markdown/Code Widgets]] (such as live queries and templates) **are now disabled** on template pages, which should make them less confusing to read and interpret.
2024-01-15 15:52:27 +00:00
* Backend work in preparation for supporting more “serverless” deployments (e.g. Cloudflare workers and Deno Deploy) in the future
* Move from [Oak](https://oakserver.github.io/oak/) to [Hono](https://hono.dev/)
* Support for in-process plug loading (without workers)
2024-01-02 13:53:17 +00:00
---
2024-01-02 12:48:46 +00:00
## 0.5.11
* Keyboard shortcuts as well as priority (order in which they appear in the [[Command Palette]]) can now be configured for [[Commands]] in [[SETTINGS]]. The `priority` enables you to put frequently used commands at the top.
* The rendering of [[Live Templates]], [[Live Queries]], [[Table of Contents]] and [[Linked Mentions]] has been re-implemented. Rendering should now be near-instant and the “flappy” behavior should be largely gone, especially after an initial load (results are cached). There may still be some visual regressions. Please report them if you find them.
2023-12-22 12:22:25 +00:00
---
2023-12-22 11:13:08 +00:00
## 0.5.10
2023-12-30 08:58:53 +00:00
* **Breaking change**: Local attachment URLs (`[page](url)` syntax and `![alt](url)` image syntax) are now interpreted relative to the page's folder unless their URL starts with a `/`, then they're relative to the space root (as per [this issue](https://github.com/silverbulletmd/silverbullet/issues/363))
2023-12-21 17:45:13 +00:00
* **Breaking change:** Revamped [[Templates]], specifically changed the format of [[Page Templates]]. The “Template: Instantiate Page” has been renamed to {[Page: From Template]}.
2023-12-30 08:58:53 +00:00
* It is now even more recommended to tag your [[Templates]] with the “template” tag because completion in [[Live Queries]] and [[Live Templates]] will now only suggest `#template` tagged pages.
2023-12-21 17:45:13 +00:00
* New [[Frontmatter]] attributes with special meaning: `displayName` and `aliases` (allowing to specify alternative names for pages)
* The [[Page Picker]] now also shows (and matches against) tags, aliases and display names for pages.
2023-12-22 10:50:20 +00:00
* It is now possible to filter pages based on tags in the [[Page Picker]] by typing a hashtag in the filter phrase, e.g. `#template` to filter pages that have a `template` tag.
2023-12-19 18:02:43 +00:00
* Added new commands to manage [[Outlines]]. Note this resulted in changing names and keyboard shortcuts for managing folds as well, to be more consistent with the other outline commands.
2023-12-15 17:58:12 +00:00
* Removed built-in multi-user [[Authentication]], `SB_AUTH` is no longer supported; use `--user` or `SB_USER` instead or an authentication layer such as [[Authelia]].
2023-12-21 17:45:13 +00:00
* Background and more experimental work:
* Work on supporting multiple database and storage backends, reviving [[Install/Deno Deploy]] support.
* This is now documented on the brand-new [[Install/Configuration]] page.
* A new `silverbullet sync` command to [[Sync]] spaces (early days, use with caution)
* Technical refactoring in preparation for multi-tenant deployment support (allowing you to run a single SB instance and serve multiple spaces and users at the same time)
* Lazy everything: plugs are now lazily loaded (after a first load, manifests are cached). On the server side, a whole lot of infrastructure is now only booted once the first HTTP request comes in
---
2023-12-07 15:53:06 +00:00
## 0.5.8
* Various bugfixes, primarily related to the new way of running docker containers, which broke things for some people. Be sure to have a look at the new [[Install/Configuration]] configuration options
2023-12-07 15:53:06 +00:00
2023-11-21 15:56:21 +00:00
---
2023-11-28 09:32:34 +00:00
## 0.5.7
* New {[Upload: File]} command to upload files and pictures (particularly valuable for mobile use cases). Implemented by [prcrst](https://github.com/silverbulletmd/silverbullet/pull/571).
2023-11-21 15:56:21 +00:00
* General support for highlighting errors (underlined) in the editor. Currently implemented for:
* All YAML fenced code blocks (and [[Frontmatter]]): will now highlight YAML parse errors
* [[Live Queries]]: will highlight non-existing query sources and non-existing template references in `render` clauses
2023-12-15 17:58:12 +00:00
* Basic [[Table of Contents]] support: any page _with 3 headers or more_ now has a “Table of Contents” widget appear (see this very page). You can toggle this feature using the {[Table of Contents: Toggle]} command.
2023-11-25 13:08:48 +00:00
* Tapping/clicking the top bar (outside of the page name and action buttons) now scrolls your page to the very top.
2023-12-15 17:58:12 +00:00
* Slightly more gracious error reporting on load when using the Online [[Client Modes]] and the server is offline.
* Any page tagged with `#template` is no longer indexed (besides as a `template`)
2023-11-28 09:32:34 +00:00
* Upgraded set of emoji (completed via the :thinking_face: syntax) to 15.1 (so more emoji)
* Various bug fixes
2023-11-21 15:56:21 +00:00
2023-11-15 09:08:21 +00:00
---
2023-11-19 11:18:16 +00:00
## 0.5.6
* Various optimization and bug fixes
* Experimental idea: [[Template Sets]]
* The `Alt-Shift-n` key was previously bound to both {[Page: New]} and {[Quick Note]}. That wont work, so now its just bound to {[Quick Note]}
2023-12-30 08:58:53 +00:00
* The `Alt-q` command is now bound to the new {[Live Queries and Templates: Refresh All]} command, refreshing all [[Live Queries]] and [[Live Templates]] on the page. This is to get yall prepared to move away from directives.
2023-11-19 11:18:16 +00:00
* Its likely that version 0.6.0 **will remove directives**, so please switch over to live queries and templates, e.g. using...
* The new {[Directive: Convert Entire Space to Live/Templates]} command, which will (attempt) to convert all uses of directives in your space automatically (backup your space before, though, just in case)
2023-11-15 09:08:21 +00:00
2023-11-13 12:31:25 +00:00
---
## 0.5.5
* Bugfix: on some filesystems that don't report file creation time (like some NASes), SilverBullet crash. This should now be fixed.
* Performance improvements the loading of code widgets (e.g. Live Queries, Live Templates)
2023-10-30 13:15:12 +00:00
---
2023-11-11 13:28:46 +00:00
## 0.5.4
* Were on a journey to rethink [[Templates]]:
* It is now _recommended_ you tag all your templates with a `#template` tag, this will exclude them from [[Objects]] indexing and may in the future be used to do better template name completion (but not yet).
* New feature: Introducing [[Slash Templates]], allowing you to create custom [[Slash Commands]]. This deprecates snippets and page templates, because [[Slash Templates]] are awesomer.
2023-10-30 13:15:12 +00:00
* Many styling fixes and improvements to [[Live Queries]] and [[Live Templates]]
* Added a “source” button to [[Live Queries]] and [[Live Templates]] for better debugging (showing you the markdown code rendered by the template so you can more easily detect issues)
* [[Live Queries]]:
2023-11-03 11:01:33 +00:00
* Support for `render all` where the entire result set is passed to a single template allowing you to e.g. dynamically build up tables, see [[Live Queries$render]] for an example.
2023-10-31 09:57:15 +00:00
* The default generated [[SETTINGS]] page now contains a link to [[SETTINGS]] on silverbullet.md for documentation purposes.
2023-11-03 11:01:33 +00:00
* The syntax to reference [[Anchors]] has now changed to use `$`, instead of `@` (e.g. [[Live Queries$render]]), the old syntax still works but is deprecated. The reason for this change is consistency: you define an anchor using the `$myanchor` syntax, referencing it the same way makes more sense.
* [[Page Name Rules]] are now documented
2023-10-30 13:15:12 +00:00
2023-10-13 14:33:49 +00:00
---
2023-10-13 15:33:24 +00:00
## 0.5.3
2023-10-13 14:33:49 +00:00
* Changes to [[Objects]]:
* Paragraphs are now indexed, see [[Objects@paragraph]] (thanks to [Ian Shehadeh](https://github.com/silverbulletmd/silverbullet/pull/528))
* For consistency, list items are now always indexed as well (whether they contain a [[Tags|tag]] or not) see [[Objects@item]].
* The {[Directive: Convert to Live Query/Template]} now also converts `#use` and `#include` directives
* Styling improvements for Linked Mentions
* SilverBullet now fully works when added as PWA on Safari 17 (via the “Add to Dock” option).
2023-12-22 15:40:38 +00:00
* Fix support for handlebars variables in [[Live Queries]] and [[Live Templates]]
2023-10-13 14:33:49 +00:00
* Plug robustness improvements (SB shouldnt fully break when loading plugs that rely on disabled syscalls)
* Various other bug fixes
2023-06-13 19:01:33 +00:00
---
2023-10-05 16:24:28 +00:00
## 0.5.1
2023-10-04 15:14:24 +00:00
* Fixes to auto-sizing of [[Live Queries]] and [[Live Templates]] widgets
* Fixed the combination of `limit` and `order by` not working well
* Auto complete for queries now works for queries split across multiple lines
* Auto complete for fenced code block languages (use the `/code` slash command)
* Slightly tweaked semantics for the `=` operator on arrays, see [[Live Queries]] for details
---
## 0.5.0
Oh boy, this is a big one. This release brings you the following:
2023-12-30 08:58:53 +00:00
* [[Objects]]: a more generic system for indexing and querying content in your space, including the ability to define your own custom object “types” (dubbed [[Tags]]). See the referenced pages for examples.
* [[Live Queries]] and [[Live Templates]]: ultimately will replace [[🔌 Directive]] in future versions and **[[🔌 Directive]] is now deprecated.** They differ from directives in that they dont materialize their output into the page itself, but rather render them on the fly so only the query/template instantiation is kept on disk. All previous directive examples on this website how now been replaced with [[Live Templates]] and [[Live Queries]]. To ease the conversion there is {[Directive: Convert Query to Live Query]} command: just put your cursor inside of an existing (query) directive and run it to auto-convert.
* The query syntax used in [[Live Queries]] (but also used in [[🔌 Directive]]) has been significantly expanded, although there may still be bugs. Theres still more value to be unlocked here in future releases.
* The previous “backlinks” plug is now built into SilverBullet as [[Linked Mentions]] and appears at the bottom of every page (if there are incoming links). You can toggle linked mentions via {[Mentions: Toggle]}.
2023-12-30 08:58:53 +00:00
* A whole bunch of [[PlugOS]] syscalls have been updated. Ill do my best update known existing plugs, but if you built existing ones some things may have broken. Please report anything broken in [Github issues](https://github.com/silverbulletmd/silverbullet/issues).
2023-10-03 14:22:58 +00:00
* This release effectively already removes the `#eval` [[🔌 Directive]] (its still there, but likely not working), this directive needs some rethinking. Join us on [Discord](https://discord.gg/EvXbFucTxn) if you have a use case for it and how you use/want to use it.
2023-10-03 20:41:51 +00:00
**Important**:
* If you have plugs such as “backlinks” or “graphview” installed, please remove them (or to be safe: all plugs) from the `_plug` folder in your space after the upgrade. Then, also remove them from your [[PLUGS]] page. The backlinks plug is now included by default (named [[Linked Mentions]]), and GraphView still needs to be updated (although its been kind of abandoned by the author).
Due to significant changes in how data is stored, likely your space will be resynced to all your clients once you upgrade. Just in case you may also want to {[Space: Reindex]} your space. If things are really broken, try the {[Debug: Reset Client]} command.
---
2023-09-09 19:06:20 +00:00
## 0.4.0
The big change in this release is that SilverBullet now supports two [[Client Modes|client modes]]: _online_ mode and _sync_ mode. Read more about them here: [[Client Modes]].
2023-08-29 19:17:29 +00:00
Other notable changes:
2023-12-19 15:18:33 +00:00
* Massive reshuffling of built-in [[🔌 Plugs]], splitting the old “core” plug into [[Plugs/Editor]], [[Plugs/Template]] and [[Plugs/Index]].
2023-09-09 19:06:20 +00:00
* Directives in [[Live Preview]] now always take up a single line height.
2023-12-19 15:18:33 +00:00
* [[Plugs/Tasks]] now support custom states (not just `[x]` and `[ ]`), for example:
* [IN PROGRESS] An in progress task
2023-09-09 19:06:20 +00:00
* [BLOCKED] A task thats blocked
[[Plugs/Tasks|Read more]]
2023-09-09 19:06:20 +00:00
* Removed [[Cloud Links]] support in favor of [[Federation]]. If you still have legacy cloud links, simply replace the 🌩️ with a `!` and things should work as before.
2023-08-28 15:12:15 +00:00