From fc115e5a746123fa90dba10a5ca19d6f2e697014 Mon Sep 17 00:00:00 2001 From: Zef Hemel Date: Sun, 17 Dec 2023 14:43:43 +0100 Subject: [PATCH] Update docs with outliner commands --- website/CHANGELOG.md | 3 ++- website/Keyboard Shortcuts.md | 11 ++++------- website/Manual.md | 1 + website/Manual/Outlines.md | 35 +++++++++++++++++++++++++++++++++++ 4 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 website/Manual/Outlines.md diff --git a/website/CHANGELOG.md b/website/CHANGELOG.md index 6860341..b0a4158 100644 --- a/website/CHANGELOG.md +++ b/website/CHANGELOG.md @@ -4,10 +4,11 @@ release. --- ## Next +* Added new commands to manage [[Manual/Outlines]]. Note this resulted in changing names and keyboard shortcuts for managing folds as well, to be more consistent with the other outline commands. * 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]]. * 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. +* 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 diff --git a/website/Keyboard Shortcuts.md b/website/Keyboard Shortcuts.md index aead51c..a6b28fb 100644 --- a/website/Keyboard Shortcuts.md +++ b/website/Keyboard Shortcuts.md @@ -10,9 +10,6 @@ Particularly useful keyboard shortcuts (that you may not know about). | Ctrl-Alt-t | Toggle table of contents| | Ctrl-Alt-m | Toggle mentions | | Cmd-Shift-f/Ctrl-Shift-f | Search for text across your entire space | -| Cmd-Alt-[/Ctrl-Shift-[ | Fold the content at the cursor position | -| Cmd-Alt-]/Ctrl-Shift-] | Unfold the content at the cursor position - # System | Combination (Mac/Win-Linux) | Action | |----------|----------| @@ -47,10 +44,10 @@ Particularly useful keyboard shortcuts (that you may not know about). | Alt-t | Toggle the state of the task at the cursor position | | Cmd-z/Ctrl-z | Undo the latest change | | Cmd-u/Ctrl-u | Go one change ahead | -| Cmd-Alt-[/Ctrl-Shift-[ | Fold the content at the cursor position | -| Cmd-Alt-]/Ctrl-Shift-] | Unfold the content at the cursor position -| Ctrl-Alt-[ | Fold the entire page by headers | -| Ctrl-Alt-] | Unfold the entire page by headers | +| Alt-Shift-Left | Fold the content at the cursor position | +| Alt-Shift-Right | Unfold the content at the cursor position +| Alt-Shift-Up | Fold the entire page by headers | +| Alt-Shift-Down | Unfold the entire page by headers | # Text | Combination (Mac/Win-Linux) | Text formatting | diff --git a/website/Manual.md b/website/Manual.md index 6fe573a..93f4521 100644 --- a/website/Manual.md +++ b/website/Manual.md @@ -25,3 +25,4 @@ However, that is unlikely to happen unless you understand some of the basics. So * [[Frontmatter]] * [[Attributes]] * [[SETTINGS]]: A few settings you can tweak +* [[Manual/Outlines]] diff --git a/website/Manual/Outlines.md b/website/Manual/Outlines.md new file mode 100644 index 0000000..29db3e7 --- /dev/null +++ b/website/Manual/Outlines.md @@ -0,0 +1,35 @@ +While SilverBullet is not a “proper” outliner, it does offer a number of useful commands to manage outlines. + +An outline is simply a (nested) bulleted list, for instance: + +* Introduction + * Context + * Problem space + * Solution space +* Problem statement + * Problem A + * Sub problem 1 + * Sub problem 2 + * Problem B + * Problem C +* Related work + * Area A + * Area B + * Area C +* Solution +* Conclusion + +SilverBullet offers a number of `Outline` commands to make manipulating such outlines easier, they are: + +* {[Outline: Move Up]}: moves the current item and its children up +* {[Outline: Move Down]}: moves the current item and its children down +* {[Outline: Move Right]}: indents the current item and its children one level deeper +* {[Outline: Move Left]}: outdents the current item and its children one level higher + +And for folding outlines: + +* {[Outline: Fold]}: folds the current item’s children +* {[Outline: Unfold]}: unfolds the current item’s children +* {[Outline: Toggle Fold]}: toggles the current item’s fold state +* {[Outline: Fold All]}: folds all sections in the entire page +* {[Outline: Unfold All]}: unfolds all sections in the entire page