docs(user): mention keyboard shortcuts

This commit is contained in:
Elian Doran 2025-05-27 20:54:17 +03:00
parent c55a3ca898
commit c3e0ef3a27
No known key found for this signature in database
7 changed files with 129 additions and 66 deletions

View File

@ -1,6 +1,4 @@
<p>&nbsp;</p>
<h1><strong>Trilium Metrics API</strong></h1>
<p>The Trilium metrics API provides comprehensive monitoring data about your
<p>The Trilium Metrics API provides comprehensive monitoring data about your
Trilium instance, designed for external monitoring systems like Prometheus.</p>
<h2><strong>Endpoint</strong></h2>
<ul>
@ -81,7 +79,4 @@ trilium_notes_total 1234 1701432000
<li><code>400</code> - Invalid format parameter</li>
<li><code>401</code> - Missing or invalid ETAPI token</li>
<li><code>500</code> - Internal server error</li>
</ul>
<p>&nbsp;</p>
<p>&nbsp;</p>
<p>&nbsp;</p>
</ul>

View File

@ -70,23 +70,16 @@
<li><kbd>Del</kbd> - delete note / sub-tree</li>
</ul>
<h2>Editing notes</h2>
<ul>
<li>For&nbsp;<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes,
<aside class="admonition note">
<p>For keyboard shortcuts specific to&nbsp;<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes,
refer to&nbsp;<a class="reference-link" href="#root/_help_oiVPnW8QfnvS">Keyboard shortcuts</a>&nbsp;and&nbsp;
<a
class="reference-link" href="#root/_help_QrtTYPmdd1qq">Markdown-like formatting</a>.</li>
<li><kbd>Alt</kbd>-<kbd>F10</kbd> - bring up inline formatting toolbar (arrow
keys <kbd><span></span></kbd>,<kbd><span></span></kbd> to navigate, <kbd>Enter</kbd> to
apply)</li>
<li><kbd>Alt</kbd>-<kbd>F10</kbd> - again to bring up block formatting toolbar</li>
<li><kbd>Enter</kbd> in tree pane switches from tree pane into note title.
class="reference-link" href="#root/_help_QrtTYPmdd1qq">Markdown-like formatting</a>.</p>
</aside>
<ul>
<li>&nbsp;<kbd>Enter</kbd> in tree pane switches from tree pane into note title.
Enter from note title switches focus to text editor. <kbd>Ctrl</kbd>+<kbd>.</kbd> switches
back from editor to tree pane.</li>
<li><kbd>Ctrl</kbd>+<kbd>K</kbd> - create / edit <a href="#root/_help_QEAPj01N5f7w">external link</a>
</li>
<li><kbd>Ctrl</kbd>+<kbd>L</kbd> - create <a href="#root/_help_QEAPj01N5f7w">internal (note) link</a>
</li>
<li><kbd>Alt</kbd>+<kbd>T</kbd> - inserts current date and time at caret position</li>
<li><kbd>Ctrl</kbd>+<kbd>.</kbd> - jump away from the editor to tree pane and
scroll to current note</li>
</ul>

View File

@ -1,3 +1,78 @@
<h2>Trilium-specific shortcuts</h2>
<figure class="table">
<table>
<thead>
<tr>
<th>Action</th>
<th>PC</th>
<th>Mac</th>
</tr>
</thead>
<tbody>
<tr>
<td>Bring up inline formatting toolbar (arrow keys <kbd><span></span></kbd>,<kbd><span></span></kbd> to
navigate, <kbd>Enter</kbd> to apply)</td>
<td><kbd>Alt</kbd>+<kbd>F10</kbd>
</td>
<td><kbd></kbd>+<kbd>F10</kbd>
</td>
</tr>
<tr>
<td>Bring up block formatting toolbar</td>
<td><kbd>Alt</kbd>+<kbd>F10</kbd>
</td>
<td><kbd></kbd>+<kbd>F10</kbd>
</td>
</tr>
<tr>
<td>Create <a href="#root/_help_QEAPj01N5f7w">external link</a>
</td>
<td><kbd>Ctrl</kbd>+<kbd>K</kbd>
</td>
<td><kbd></kbd>+<kbd>K</kbd>
</td>
</tr>
<tr>
<td>Create <a href="#root/_help_QEAPj01N5f7w">internal (note) link</a>
</td>
<td><kbd>Ctrl</kbd>+<kbd>L</kbd>
</td>
<td><kbd></kbd>+<kbd>L</kbd>
</td>
</tr>
<tr>
<td>Inserts current date and time at caret position</td>
<td><kbd>Alt</kbd>+<kbd>T</kbd>&nbsp;</td>
<td><kbd></kbd>+<kbd>T</kbd>&nbsp;</td>
</tr>
<tr>
<td rowspan="2">Move blocks (lists, paragraphs, etc.) up</td>
<td><kbd>Ctrl</kbd>+<kbd></kbd>&nbsp;</td>
<td><kbd></kbd>+<kbd></kbd>&nbsp;</td>
</tr>
<tr>
<td><kbd>Alt</kbd>+<kbd></kbd>
</td>
<td><kbd></kbd>+<kbd></kbd>
</td>
</tr>
<tr>
<td rowspan="2">Move blocks (lists, paragraphs, etc.) down</td>
<td><kbd>Ctrl</kbd>+<kbd></kbd>
</td>
<td><kbd></kbd>+<kbd></kbd>
</td>
</tr>
<tr>
<td><kbd>Alt</kbd>+<kbd></kbd>
</td>
<td><kbd></kbd>+<kbd></kbd>
</td>
</tr>
</tbody>
</table>
</figure>
<h2>Common shortcuts</h2>
<aside class="admonition tip">
<p>This section of keyboard shortcuts presents a subset of the keyboard shortcuts
as supported by the editor technology we are using,&nbsp;<a class="reference-link"
@ -155,7 +230,6 @@
</tbody>
</table>
</figure>
<h3>Interacting with blocks</h3>
<p>Blocks are images, tables, blockquotes, annotations.</p>
<figure class="table">
@ -269,7 +343,6 @@
</tbody>
</table>
</figure>
<h3>General UI shortcuts</h3>
<figure class="table">
<table>

View File

@ -4086,34 +4086,6 @@
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "oiVPnW8QfnvS",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "QrtTYPmdd1qq",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "QEAPj01N5f7w",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
@ -4134,6 +4106,27 @@
"value": "bx bxs-keyboard",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "oiVPnW8QfnvS",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "QrtTYPmdd1qq",
"isInheritable": false,
"position": 110
}
],
"format": "markdown",
@ -6127,19 +6120,26 @@
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "MI26XDLSAlCD",
"isInheritable": false,
"position": 10
},
{
"type": "label",
"name": "iconClass",
"value": "bx bxs-keyboard",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "MI26XDLSAlCD",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "QEAPj01N5f7w",
"isInheritable": false,
"position": 50
}
],
"format": "markdown",

View File

@ -1,6 +1,5 @@
# **Trilium Metrics API**
The Trilium metrics API provides comprehensive monitoring data about your Trilium instance, designed for external monitoring systems like Prometheus.
# Metrics
The Trilium Metrics API provides comprehensive monitoring data about your Trilium instance, designed for external monitoring systems like Prometheus.
## **Endpoint**

View File

@ -49,13 +49,10 @@ Only in desktop (electron build):
## Editing notes
* For <a class="reference-link" href="../Note%20Types/Text.md">Text</a> notes, refer to <a class="reference-link" href="../Note%20Types/Text/Keyboard%20shortcuts.md">Keyboard shortcuts</a> and <a class="reference-link" href="../Note%20Types/Text/Markdown-like%20formatting.md">Markdown-like formatting</a>.
* <kbd>Alt</kbd>\-<kbd>F10</kbd> - bring up inline formatting toolbar (arrow keys <kbd><span></span></kbd>,<kbd><span></span></kbd> to navigate, <kbd>Enter</kbd> to apply)
* <kbd>Alt</kbd>\-<kbd>F10</kbd> - again to bring up block formatting toolbar
> [!NOTE]
> For keyboard shortcuts specific to <a class="reference-link" href="../Note%20Types/Text.md">Text</a> notes, refer to <a class="reference-link" href="../Note%20Types/Text/Keyboard%20shortcuts.md">Keyboard shortcuts</a> and <a class="reference-link" href="../Note%20Types/Text/Markdown-like%20formatting.md">Markdown-like formatting</a>.
* <kbd>Enter</kbd> in tree pane switches from tree pane into note title. Enter from note title switches focus to text editor. <kbd>Ctrl</kbd>+<kbd>.</kbd> switches back from editor to tree pane.
* <kbd>Ctrl</kbd>+<kbd>K</kbd> - create / edit [external link](../Note%20Types/Text/Links.md)
* <kbd>Ctrl</kbd>+<kbd>L</kbd> - create [internal (note) link](../Note%20Types/Text/Links.md)
* <kbd>Alt</kbd>+<kbd>T</kbd> - inserts current date and time at caret position
* <kbd>Ctrl</kbd>+<kbd>.</kbd> - jump away from the editor to tree pane and scroll to current note
## Runtime shortcuts

View File

@ -1,4 +1,10 @@
# Keyboard shortcuts
## Trilium-specific shortcuts
<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Bring up inline formatting toolbar (arrow keys <kbd><span></span></kbd>,<kbd><span></span></kbd> to navigate, <kbd>Enter</kbd> to apply)</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd></kbd>+<kbd>F10</kbd></td></tr><tr><td>Bring up block formatting toolbar</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd></kbd>+<kbd>F10</kbd></td></tr><tr><td>Create <a href="Links.md">external link</a></td><td><kbd>Ctrl</kbd>+<kbd>K</kbd></td><td><kbd></kbd>+<kbd>K</kbd></td></tr><tr><td>Create <a href="Links.md">internal (note) link</a></td><td><kbd>Ctrl</kbd>+<kbd>L</kbd></td><td><kbd></kbd>+<kbd>L</kbd></td></tr><tr><td>Inserts current date and time at caret position</td><td><kbd>Alt</kbd>+<kbd>T</kbd>&nbsp;</td><td><kbd></kbd>+<kbd>T</kbd>&nbsp;</td></tr><tr><td rowspan="2">Move blocks (lists, paragraphs, etc.) up</td><td><kbd>Ctrl</kbd>+<kbd></kbd>&nbsp;</td><td><kbd></kbd>+<kbd></kbd>&nbsp;</td></tr><tr><td><kbd>Alt</kbd>+<kbd></kbd></td><td><kbd></kbd>+<kbd></kbd></td></tr><tr><td rowspan="2">Move blocks (lists, paragraphs, etc.) down</td><td><kbd>Ctrl</kbd>+<kbd></kbd></td><td><kbd></kbd>+<kbd></kbd></td></tr><tr><td><kbd>Alt</kbd>+<kbd></kbd></td><td><kbd></kbd>+<kbd></kbd></td></tr></tbody></table></figure>
## Common shortcuts
> [!TIP]
> This section of keyboard shortcuts presents a subset of the keyboard shortcuts as supported by the editor technology we are using, <a class="reference-link" href="../../Advanced%20Usage/Technologies%20used/CKEditor.md">CKEditor</a>. The shortcuts were taken from the [official documentation](https://ckeditor.com/docs/ckeditor5/latest/features/accessibility.html#keyboard-shortcuts). Note that not all the shortcuts in the original documentation are applicable (due to using a different configuration).