From 15c121f95025c963ed9270a3f359a03a62f5ea92 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Sat, 18 Apr 2026 10:54:57 +0300 Subject: [PATCH] docs(user): document linking to bookmarks --- .../Navigation/Bookmarks.html | 5 ++ .../Notes/Printing & Exporting as PDF.html | 21 +++---- .../User Guide/Note Types/Text/Bookmarks.html | 60 ++++++++++++++++--- .../Developer Guide/Documentation.md | 2 +- docs/User Guide/!!!meta.json | 42 +++++++++++++ .../Navigation/Bookmarks.md | 3 + .../User Guide/Note Types/Text/Bookmarks.md | 25 +++++++- 7 files changed, 133 insertions(+), 25 deletions(-) diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.html index 07943c9924..32231b4d69 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.html @@ -1,3 +1,8 @@ +

Frequently used notes can be bookmarked, which will make them appear in the Launch Bar for easy access.

diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html index 95992cf3d4..721b20ed26 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html @@ -61,8 +61,7 @@ class="admonition note">
  • To place a link to a bookmark:
      @@ -23,9 +33,41 @@
    • -

    Limitations

    - \ No newline at end of file +

    Linking across notes

    +

    Trilium v0.103.0 introduces cross-note bookmarks, which makes it possible + to create Internal (reference) links which + point to a specific bookmark in that document.

    +

    To do so:

    +
      +
    1. +

      First, create a bookmark in the target note using the same process as + described above.

      +
      2. +
    2. +

      In another note, press Ctrl+L to insert an internal + link. Select the target note containing bookmarks.

      +
      3. +
    3. +

      If the target note contains bookmarks, a section will appear underneath + the note selector with the list of bookmarks.

      +
      4. +
    4. +

      Add the link normally.

      +
      5. +
    +

    Clicking on a reference link pointing to a bookmark will automatically + scroll to the desired section.

    + \ No newline at end of file diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md index 8b2fdc9998..18b7705caf 100644 --- a/docs/Developer Guide/Developer Guide/Documentation.md +++ b/docs/Developer Guide/Developer Guide/Documentation.md @@ -1,5 +1,5 @@ # Documentation -There are multiple types of documentation for Trilium: +There are multiple types of documentation for Trilium: * The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1. * The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers. diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index 92af202232..61858de2ff 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -5413,6 +5413,20 @@ "value": "bx bx-bookmarks", "isInheritable": false, "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "oSuaNgyyKnhu", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "iPIMuisry3hd", + "isInheritable": false, + "position": 50 } ], "format": "markdown", @@ -7305,6 +7319,34 @@ "value": "bookmarks", "isInheritable": false, "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "u3YFHC9tQlpm", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xYmIYSP6wE3F", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "ZlN4nump6EbW", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "hrZ1D00cLbal", + "isInheritable": false, + "position": 70 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md b/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md index 332ec24172..321cf83f21 100644 --- a/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md +++ b/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md @@ -1,4 +1,7 @@ # Bookmarks +> [!NOTE] +> Not to be confused with the Bookmarks concept for Text notes which acts like anchors, allowing navigation to a particular section. + Frequently used notes can be bookmarked, which will make them appear in the Launch Bar for easy access. ## Configuring the launch bar diff --git a/docs/User Guide/User Guide/Note Types/Text/Bookmarks.md b/docs/User Guide/User Guide/Note Types/Text/Bookmarks.md index e6321b5b89..6a699b139c 100644 --- a/docs/User Guide/User Guide/Note Types/Text/Bookmarks.md +++ b/docs/User Guide/User Guide/Note Types/Text/Bookmarks.md @@ -1,5 +1,8 @@ # Bookmarks -Bookmarks allows creating [links](Links.md) to a certain part of a note, such as referencing a particular heading. +> [!NOTE] +> Not to be confused with [bookmarked notes](../../Basic%20Concepts%20and%20Features/Navigation/Bookmarks.md), which simply pins a particular note to the Launch Bar for easy access. + +Bookmarks allows creating [links](Links.md) to a certain part of a note, such as referencing a particular heading or section within a note. Technically, bookmarks are HTML anchors. @@ -10,10 +13,26 @@ This feature was introduced in TriliumNext 0.94.0. * To create a bookmark: * Place the cursor at the desired position where to place the bookmark. * Look for the button in the Formatting toolbar, and then press the button. + * Alternatively, use Slash Commands and look for _Bookmark_. * To place a link to a bookmark: * Place the cursor at the desired position of the link. * From the [link](Links.md) pane, select the _Bookmarks_ section and select the desired bookmark. -## Limitations +## Linking across notes -* Currently it's not possible to create a link to a bookmark from a different note. This functionality will be added after the internal links feature is enhanced to support bookmarks. \ No newline at end of file +Trilium v0.103.0 introduces cross-note bookmarks, which makes it possible to create Internal (reference) links which point to a specific bookmark in that document. + +To do so: + +1. First, create a bookmark in the target note using the same process as described above. +2. In another note, press Ctrl+L to insert an internal link. Select the target note containing bookmarks. +3. If the target note contains bookmarks, a section will appear underneath the note selector with the list of bookmarks. +4. Add the link normally. + +Clicking on a reference link pointing to a bookmark will automatically scroll to the desired section. + +> [!NOTE] +> For notes created prior to Trilium v0.103.0, you might notice that the bookmarks might not be identified: +> +> * To fix this, simply go that note and make any change (e.g. inserting a space), this will trigger the recalculation of the links. +> * This limitation is intentional in order not to have to re-process all the notes, looking for anchors. \ No newline at end of file