feat(docs): reorganize & merge attachments

This commit is contained in:
Elian Doran
2025-04-06 16:04:55 +03:00
parent fb6e6241d9
commit c9e3fb90f1
189 changed files with 1650 additions and 4441 deletions

View File

@@ -7,7 +7,7 @@ Trilium Notes supports importing Markdown restricted to the [CommonMark specific
If you want to import just a chunk of markdown from clipboard, you can do it from editor block menu:
![](../../Attachments/markdown-inline-import.gif)
![](Markdown_markdown-inline-i.gif)
### File import
@@ -20,7 +20,7 @@ You can also import Markdown files from files:
\[\[gifs/markdown-file-import.gif\]\]
![](../../Attachments/markdown-file-import.gif)
![](Markdown_markdown-file-imp.gif)
## Export
@@ -28,13 +28,13 @@ You can also import Markdown files from files:
You can export whole subtree to ZIP archive which will have directory structured modelled after subtree structure:
![](../../Attachments/markdown-export-subtree.gif)
![](Markdown_markdown-export-s.gif)
### Single note export
If you want to export just single note without its subtree, you can do it from Note actions menu:
![](../../Attachments/markdown-export-note.gif)
![](Markdown_markdown-export-n.gif)
### Exporting protected notes

Binary file not shown.

After

Width:  |  Height:  |  Size: 332 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 309 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 714 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB

View File

@@ -1,12 +1,12 @@
# Bookmarks
To easily access selected notes, you can bookmark them. See demo:
![](../../Attachments/bookmarks.gif)
![](Bookmarks_bookmarks.gif)
## Bookmark folder
Space in the left panel is limited, and you might want to bookmark many items. One possible solution is to bookmark a folder, so it shows its children:
![](../../Attachments/bookmark-folder.png)
![](Bookmarks_bookmark-folder.png)
To do this, you need to add a `#bookmarkFolder` label to the note.

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 305 KiB

View File

@@ -8,8 +8,18 @@ The _Jump to Note_ function allows easy navigation between notes by searching fo
* In the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, press ![](1_Jump%20to%20Note_image.png) button.
* Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.
## Recent notes
Jump to note also has the ability to show the list of recently viewed / edited notes and quickly jump to it.
To access this functionality, click on `Jump to` button on the top. By default, (when nothing is entered into autocomplete), this dialog will show the list of recent notes.
Alternatively you can click on the "time" icon on the right.
<img src="Jump to Note_recent-notes.gif" width="812" height="585">
## Interaction
* By default, when there is no text entered it will display the most recent notes (see <a class="reference-link" href="Note%20Navigation.md">Note Navigation</a>).
* By default, when there is no text entered it will display the most recent notes.
* Using the keyboard, use the up or down arrow keys to navigate between items. Press <kbd>Enter</kbd> to open the desired note.
* If the note doesn't exist, it's possible to create it by typing the desired note title and selecting the _Create and link child note_ option.

Binary file not shown.

After

Width:  |  Height:  |  Size: 265 KiB

View File

@@ -1,7 +1,7 @@
# Note Hoisting
Hoisting is a standard outliner feature which allows you to focus on (or "zoom into") a specific note and its subtree by hiding all parent and sibling notes. Demo:
![](../../Attachments/note-hoisting.gif)
![](Note%20Hoisting_note-hoistin.gif)
In addition to showing only this subtree, this also narrows both full text search and [“jump to note”](Note%20Navigation.md) to just notes present in hoisted subtree.

Binary file not shown.

After

Width:  |  Height:  |  Size: 178 KiB

View File

@@ -11,16 +11,6 @@ This works identically to browser backwards / forwards, it's actually using buil
## Jump to note
This is useful to quickly find and view arbitrary note - click on `Jump to` button on the top or press <kbd>Ctrl</kbd> + <kbd>J</kbd> . Then type part of the note name and autocomplete will help you pick the desired note.
This is useful to quickly find and view arbitrary notes - click on `Jump to` button on the top or press <kbd>Ctrl</kbd> + <kbd>J</kbd> . Then type part of the note name and autocomplete will help you pick the desired note.
![](../../Attachments/jump-to.gif)
### Recent notes
Jump to note also has the ability to show the list of recently viewed / edited notes and quickly jump to it.
To access this functionality, click on `Jump to` button on the top. By default, (when nothing is entered into autocomplete), this dialog will show the list of recent notes.
Alternatively you can click on the "time" icon on the right.
![](../../Attachments/recent-notes.gif)
See <a class="reference-link" href="Jump%20to%20Note.md">Jump to Note</a> for more information.

View File

@@ -7,4 +7,4 @@ This can be useful for notes which are no longer very useful but still valuable
You can control whether archived notes are displayed in the note tree with a setting:
![](../../Attachments/hide-archived.png)
![](Archived%20Notes_hide-archiv.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

View File

@@ -7,6 +7,15 @@ Each note exclusively owns its attachments, meaning attachments cannot be shared
Attachments, especially image files, are the recommended method for embedding visuals in notes. It is important to link image attachments within the text of the owning note; otherwise, they will be automatically deleted after a configurable timeout period if not referenced.
## Converting notes to attachments
<a class="reference-link" href="../../Note%20Types/File.md">File</a> notes can be easily converted to attachments of the parent note.
To do so:
* For a single note, press the context menu from the <a class="reference-link" href="../UI%20Elements/Note%20buttons.md">Note buttons</a> and select _Convert into attachment_.
* For multiple notes, select the given notes in the <a class="reference-link" href="../UI%20Elements/Note%20Tree.md">Note Tree</a>, right click → Advanced → Convert to attachment.
## Attachment previews
Attachments share the same content preview for images, videos, PDFs, etc. as the <a class="reference-link" href="../../Note%20Types/File.md">File</a> note type.

View File

@@ -43,7 +43,7 @@ So now the "Bash" subtree appears on multiple locations in the hierarchy. Both t
### Demo
![](../../Attachments/create-clone.gif)
![](Cloning%20Notes_create-clone.gif)
In the demo, you can see how a clone can be created using the context menu. It's possible to do this also using the Add Link dialog or with <kbd>Ctrl</kbd>+<kbd>C</kbd> and <kbd>Ctrl</kbd>+<kbd>V</kbd> [keyboard shortcuts](../Keyboard%20Shortcuts.md).

Binary file not shown.

After

Width:  |  Height:  |  Size: 367 KiB

View File

@@ -1,6 +1,6 @@
# Note Icons
Icons are useful for distinguishing notes. At the technical level, they are set by the `iconClass` attribute which adds a CSS class to the note. For example `#iconClass="bx bx-calendar"` will show a calendar instead of the default page or folder icon. Looking up and remembering the css class names is not necessary. While editing a note, click on the icon next to the title to bring up a chooser gallery:
![change note icon](../../Attachments/note-icon-change.png)
![change note icon](Note%20Icons_note-icon-chang.png)
![note icon gallery](../../Attachments/note-icon-gallery.png)
![note icon gallery](Note%20Icons_note-icon-galle.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

View File

@@ -17,4 +17,4 @@ You can click the **Erase excess revision snapshots now** button to apply the ch
Note revisions can be accessed through the button on the right of ribbon toolbar.
![](../../Attachments/note-revisions.png)
![](Note%20Revisions_note-revisi.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 155 KiB

View File

@@ -10,7 +10,7 @@ Trilium is designed to store a wide variety of data, including sensitive informa
By default, notes are unprotected. To protect a note, simply click on the shield icon next to the note's title, as shown here:
![example animation of unlocking protected notes](../../Attachments/protecting-note.gif)
![example animation of unlocking protected notes](Protected%20Notes_protecting.gif)
## What is Encrypted?

Binary file not shown.

After

Width:  |  Height:  |  Size: 716 KiB

View File

@@ -3,7 +3,7 @@
Trilium comes with a couple pre-installed color themes, with the default being a light theme. To switch to a dark theme or any other available theme, navigate to the Options menu (accessible via the app icon in the top-left corner), select the Appearance tab, and choose your preferred theme.
![Dark Theme](../Attachments/dark-theme.png)
![Dark Theme](Themes_dark-theme.png)
## Creating Custom CSS Themes
@@ -85,7 +85,7 @@ Custom themes can be exported as `.tar` archives, which can be shared with other
An example user theme, _Steel Blue_, is available in the demo document.
![Steel Blue Theme](../Attachments/steel-blue.png)
![Steel Blue Theme](Themes_steel-blue.png)
### Using Custom CSS for Specific Purposes

Binary file not shown.

After

Width:  |  Height:  |  Size: 235 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 248 KiB

View File

@@ -5,13 +5,13 @@ This page explains how to manipulate the note tree in TriliumNext, focusing on m
## Drag and Drop
![Drag and drop example](../../Attachments/drag-and-drop.gif)
![Drag and drop example](Note%20Tree_drag-and-drop.gif)
You can easily rearrange the note tree by dragging and dropping notes, as demonstrated in the example above.
## Keyboard Manipulation
![Example of using keyboard keys to move a note](../../Attachments/move-note-with-keyboard.gif)Trilium offers efficient keyboard-based manipulation using the following [shortcuts](../Keyboard%20Shortcuts.md):
![Example of using keyboard keys to move a note](Note%20Tree_move-note-with-k.gif)Trilium offers efficient keyboard-based manipulation using the following [shortcuts](../Keyboard%20Shortcuts.md):
* <kbd>Ctrl</kbd> + <kbd><span>↑</span></kbd> and <kbd>Ctrl</kbd> +<kbd><span>↓</span></kbd>: Move the note up or down in the order.
* <kbd>Ctrl</kbd>+<kbd><span>←</span></kbd>: Move the note up in the hierarchy by changing its parent to the note's grandparent.

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 562 KiB

View File

@@ -25,7 +25,7 @@ If you are using the _Fixed_ formatting toolbar, all the formatting buttons for
* Is always editable, regardless of its size.
* _**Bookmark**_ toggles the display of the current note into the [Launch Bar](Launch%20Bar.md) for easy access. See [Bookmarks](../Navigation/Bookmarks.md) for more information.
* _**Shared**_ toggles whether the current note is publicly accessible if you have a [server instance](../../Installation%20%26%20Setup/Server%20Installation.md) set up. See [Sharing](../../Advanced%20Usage/Sharing.md) for more information.
* _**Template**_ toggles whether the current note is considered a template and can be used to easily create notes with the same content. See [Template](../../Advanced%20Usage/Attributes/Template.md) for more information.
* _**Template**_ toggles whether the current note is considered a template and can be used to easily create notes with the same content. See [Template](../../Advanced%20Usage/Templates.md) for more information.
* _**Language**_ changes the main language of the current note, mostly useful for spell checking or right-to-left support. See [Content language & Right-to-left support](../../Note%20Types/Text/Content%20language%20%26%20Right-to-le.md) for more information.
### Owned Attributes