From a439e7c29b5f8d31c559f4af492e230663304c00 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Sat, 18 Apr 2026 12:30:12 +0300 Subject: [PATCH] docs(user): sync --- .../Installation & Setup/Data directory.html | 20 +- .../User Guide/Note Types/Markdown.html | 61 ++-- .../User Guide/Note Types/Text.html | 333 +++++++++--------- .../User Guide/Note Types/Text/Anchors.html | 33 +- .../Note Types/Text/Insert buttons.html | 2 +- .../Links/Internal (reference) links.html | 7 +- .../Developer Guide/Documentation.md | 2 +- docs/User Guide/!!!meta.json | 87 +++-- .../User Guide/Note Types/Markdown.md | 6 +- .../Note Types/Text/Insert buttons.md | 2 +- 10 files changed, 281 insertions(+), 272 deletions(-) diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html index ecd52a4302..447e08f942 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html @@ -77,14 +77,12 @@ (e.g. %APPDATA% on Windows), which may be undesirable in corporate environments with roaming profiles or when running in portable mode.

-

When TRILIUM_DATA_DIR is set (e.g. via the +

To keep Electron data out of the system's roaming profile, set the trilium-portablescript), the Electron user data is automatically - redirected into ${TRILIUM_DATA_DIR}/electron-user-data/, - so no files are written to the system's roaming profile.

-

If you need to store the Electron data in a different location than the - Trilium data directory, you can set the TRILIUM_ELECTRON_DATA_DIR environment - variable to an explicit path.

+ spellcheck="false">TRILIUM_ELECTRON_DATA_DIRenvironment variable to an explicit path. + The trilium-portable script does this automatically, + pointing it to trilium-electron-data/ next + to the application.

Fine-grained directory/path location

Apart from the data directory, some of the subdirectories of it can be moved elsewhere by changing an environment variable:

@@ -147,10 +145,10 @@ TRILIUM_ELECTRON_DATA_DIR - ${TRILIUM_DATA_DIR}/electron-user-data (portable) - or system appData (default) - Directory where Electron stores internal data such as caches and spell-check - dictionaries (desktop only). + System appData + Directory for Electron internal data (caches, spell-check dictionaries, + etc.). Set this in portable mode to avoid writing to the system profile + (desktop only). \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html index 2d3d41e7f9..9d06e36996 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html @@ -32,32 +32,38 @@

The following features are supported by Trilium's Markdown format and will show up in the preview pane:

Creating Markdown notes

There are two ways to create a Markdown note:

  1. Create a new note (e.g. in the Note Tree) and select the type Markdown, just like all the other note types.
    2. -
  2. Create a note of type Code and +
  3. Create a note of type Code and select as the language either Markdown or GitHub-Flavored Markdown. This maintains compatibility with your existing notes prior to the introduction of this feature.
    4. @@ -70,10 +76,9 @@

    Import/export

      -
    • -

      By default, when importing a single Markdown file it automatically gets - converted to a Text note. - To avoid that and have it imported as a Markdown note instead:

      +
    • By default, when importing a single Markdown file it automatically gets + converted to a Text note. + To avoid that and have it imported as a Markdown note instead:
      • Right click the Note Tree and select Import into note.
        • @@ -81,14 +86,10 @@
      • Uncheck Import HTML, Markdown and TXT as text notes if it's unclear from the metadata.
      • -
    • -

      When exporting Markdown files, the extension is preserved and the content - remains the same as in the source view.

      -
      • -
    • -

      Once exported as a Trilium ZIP, the ZIP will preserve the Markdown type - without converting to text notes thanks to the meta-information in it.

      -
      • +
    • When exporting Markdown files, the extension is preserved and the content + remains the same as in the source view.
      • +
    • Once exported as a Trilium ZIP, the ZIP will preserve the Markdown type + without converting to text notes thanks to the meta-information in it.

    Conversion between text notes and Markdown notes

    Currently there is no built-in functionality to convert a Fore more information see Formatting toolbar.

    Features and formatting

    Here's a list of various features supported by text notes:

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Dedicated articleFeature
    General formatting - -
      -
    • Headings (section titles, paragraph)
      • -
    • Font size
      • -
    • Bold, italic, underline, strike-through
      • -
    • Superscript, subscript
      • -
    • Font color & background color
      • -
    • Remove formatting
      • -
    -
    Lists - -
      -
    • Bulleted lists
      • -
    • Numbered lists
      • -
    • To-do lists
      • -
    -
    Block quotes & admonitions - -
      -
    • Block quotes
      • -
    • Admonitions
      • -
    -
    Tables - -
      -
    • Basic tables
      • -
    • Merging cells
      • -
    • Styling tables and cells.
      • -
    • Table captions
      • -
    -
    Developer-specific formatting - -
      -
    • Inline code
      • -
    • Code blocks
      • -
    • Keyboard shortcuts
      • -
    -
    Footnotes - -
      -
    • Footnotes
      • -
    -
    Images - -
      -
    • Images
      • -
    -
    Links - -
      -
    • External links
      • -
    • Internal Trilium links
      • -
    -
    Include Note - -
      -
    • Include note
      • -
    -
    Insert buttons - -
      -
    • Symbols
      • -
    • Math Equations -
      • -
    • Mermaid diagrams
      • -
    • Horizontal ruler
      • -
    • Page break
      • -
    -
    Other features - - -
    Premium features - - -
    -
    -

    Read-Only vs. Editing Mode

    -

    Text notes are usually opened in edit mode. However, they may open in - read-only mode if the note is too big or the note is explicitly marked - as read-only. For more information, see Read-Only Notes.

    -

    Keyboard shortcuts

    -

    There are numerous keyboard shortcuts to format the text without having - to use the mouse. For a reference of all the key combinations, see  - Keyboard Shortcuts. In addition, see Markdown-like formatting as an alternative - to the keyboard shortcuts.

    -

    Technical details

    -

    For the text editing functionality, Trilium uses a commercial product - (with an open-source base) called CKEditor. - This brings the benefit of having a powerful WYSIWYG (What You See Is What - You Get) editor.

    \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Dedicated articleFeature
    General formatting + +
      +
    • Headings (section titles, paragraph)
      • +
    • Font size
      • +
    • Bold, italic, underline, strike-through
      • +
    • Superscript, subscript
      • +
    • Font color & background color
      • +
    • Remove formatting
      • +
    +
    Lists + +
      +
    • Bulleted lists
      • +
    • Numbered lists
      • +
    • To-do lists
      • +
    +
    Block quotes & admonitions + +
      +
    • Block quotes
      • +
    • Admonitions
      • +
    +
    Tables + +
      +
    • Basic tables
      • +
    • Merging cells
      • +
    • Styling tables and cells.
      • +
    • Table captions
      • +
    +
    Developer-specific formatting + +
      +
    • Inline code
      • +
    • Code blocks
      • +
    • Keyboard shortcuts
      • +
    +
    Footnotes + +
      +
    • Footnotes
      • +
    +
    Images + +
      +
    • Images
      • +
    +
    Links + +
      +
    • External links
      • +
    • Internal Trilium links
      • +
    +
    Include Note + +
      +
    • Include note
      • +
    +
    Insert buttons + +
      +
    • Symbols
      • +
    • Math Equations +
      • +
    • Mermaid diagrams
      • +
    • Horizontal ruler
      • +
    • Page break
      • +
    +
    Other features + + +
    Premium features + + +
    +

    Read-Only vs. Editing Mode

    +

    Text notes are usually opened in edit mode. However, they may open in + read-only mode if the note is too big or the note is explicitly marked + as read-only. For more information, see Read-Only Notes.

    +

    Keyboard shortcuts

    +

    There are numerous keyboard shortcuts to format the text without having + to use the mouse. For a reference of all the key combinations, see  + Keyboard Shortcuts. In addition, see Markdown-like formatting as an alternative + to the keyboard shortcuts.

    +

    Technical details

    +

    For the text editing functionality, Trilium uses a commercial product + (with an open-source base) called CKEditor. + This brings the benefit of having a powerful WYSIWYG (What You See Is What + You Get) editor.

    \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Anchors.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Anchors.html index 80dbdc9a93..8724f8a93d 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Anchors.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Anchors.html @@ -1,7 +1,7 @@ @@ -15,16 +15,15 @@
  4. To create a anchor:
    • Place the cursor at the desired position where to place the anchor.
      • -
    • Look for the +
    • Look for the button in the Formatting toolbar, and then press the button.
      • -
    • Alternatively, use Slash Commands and - look for anchor.
      • -
    +
  5. Alternatively, use Slash Commands and + look for anchor.
    6. +
  6. To place a link to a anchor:
      @@ -36,7 +35,7 @@

    Linking across notes

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

    Compatibility with documents from previous versions

    For notes created prior to Trilium v0.103.0, you might notice that the @@ -58,22 +57,14 @@ to the desired section.

    Linking to anchors through the bookmark toolbar

      -
    1. -

      Create an anchor in the target note using the same process as described - above.

      -
      2. -
    2. -

      Click on the anchor to reveal the anchor's floating toolbar.

      -
      3. -
    3. -

      Click on the Copy anchor reference link button.

      -
      4. -
    4. -

      Go to the note where to insert the link and press Ctrl+V.

      -
      5. +
    5. Create an anchor in the target note using the same process as described + above.
      6. +
    6. Click on the anchor to reveal the anchor's floating toolbar.
      7. +
    7. Click on the Copy anchor reference link button.
      8. +
    8. Go to the note where to insert the link and press Ctrl+V.
    \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons.html index e1bfe092f2..550f54e9f1 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons.html @@ -4,7 +4,7 @@ reveal special inserable items and blocks such as symbols, Math expressions and separators.

    Bookmarks

    -

    See the dedicated Bookmarks section.

    +

    See the dedicated Anchors section.

    Emoji

    button underneath the menu in the Formatting toolbar.
    7. -
  7. Searching for the title of the desired note to link. It's also possible +
  8. Searching for the title of the desired note to link. It's also possible to create new notes from this dialog by typing a non-existing note title and selecting Create and link child note.

There are two link types which you can select when creating the link to the note:

    -
  1. Link title mirrors the note's current title +
  2. Link title mirrors the note's current title
    1. This is sometimes also called "reference link".
    2. The title of this link cannot be changed. Instead, it will always show @@ -25,7 +24,7 @@
    3. The icon of the linked note will also be displayed.
    3. -
  3. Link title can be changed arbitrarily +
  4. Link title can be changed arbitrarily
    1. This will create a traditional hyperlink, where the text of the link can be different from the note title.
      2. diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md index 18b7705caf..9818ff97ba 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 e7dadd05b5..caa6550464 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -7207,17 +7207,38 @@ { "type": "relation", "name": "internalLink", - "value": "QEAPj01N5f7w", + "value": "u3YFHC9tQlpm", "isInheritable": false, "position": 10 }, { "type": "relation", "name": "internalLink", - "value": "nRhnJkTT8cPs", + "value": "QEAPj01N5f7w", "isInheritable": false, "position": 20 }, + { + "type": "relation", + "name": "internalLink", + "value": "nRhnJkTT8cPs", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "ZlN4nump6EbW", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "hrZ1D00cLbal", + "isInheritable": false, + "position": 50 + }, { "type": "label", "name": "iconClass", @@ -7231,27 +7252,6 @@ "value": "bookmarks", "isInheritable": false, "position": 30 - }, - { - "type": "relation", - "name": "internalLink", - "value": "ZlN4nump6EbW", - "isInheritable": false, - "position": 60 - }, - { - "type": "relation", - "name": "internalLink", - "value": "hrZ1D00cLbal", - "isInheritable": false, - "position": 70 - }, - { - "type": "relation", - "name": "internalLink", - "value": "u3YFHC9tQlpm", - "isInheritable": false, - "position": 80 } ], "format": "markdown", @@ -9016,7 +9016,7 @@ "dEHYtoWWi8ct" ], "title": "Other features", - "notePosition": 190, + "notePosition": 180, "prefix": null, "isExpanded": false, "type": "text", @@ -9136,7 +9136,7 @@ "gLt3vA97tMcp" ], "title": "Premium features", - "notePosition": 200, + "notePosition": 190, "prefix": null, "isExpanded": false, "type": "text", @@ -9459,7 +9459,7 @@ "oBo3iHIZnbG2" ], "title": "Spell Check", - "notePosition": 210, + "notePosition": 200, "prefix": null, "isExpanded": false, "type": "text", @@ -9494,7 +9494,7 @@ "BFvAtE74rbP6" ], "title": "Table of contents", - "notePosition": 220, + "notePosition": 210, "prefix": null, "isExpanded": false, "type": "text", @@ -9566,7 +9566,7 @@ "NdowYOC1GFKS" ], "title": "Tables", - "notePosition": 230, + "notePosition": 220, "prefix": null, "isExpanded": false, "type": "text", @@ -10891,38 +10891,59 @@ { "type": "relation", "name": "internalLink", - "value": "nBAXQFj20hS1", + "value": "NwBbFdNZ9h7O", "isInheritable": false, "position": 50 }, { "type": "relation", "name": "internalLink", - "value": "hrZ1D00cLbal", + "value": "YfYAtQBcfo5V", "isInheritable": false, "position": 60 }, { "type": "relation", "name": "internalLink", - "value": "m1lbrzyKDaRB", + "value": "s1aBHPd79XYj", "isInheritable": false, "position": 70 }, { "type": "relation", "name": "internalLink", - "value": "oPVyFC7WL2Lp", + "value": "nBAXQFj20hS1", "isInheritable": false, "position": 80 }, { "type": "relation", "name": "internalLink", - "value": "wy8So3yZZlH9", + "value": "hrZ1D00cLbal", "isInheritable": false, "position": 90 }, + { + "type": "relation", + "name": "internalLink", + "value": "m1lbrzyKDaRB", + "isInheritable": false, + "position": 100 + }, + { + "type": "relation", + "name": "internalLink", + "value": "oPVyFC7WL2Lp", + "isInheritable": false, + "position": 110 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wy8So3yZZlH9", + "isInheritable": false, + "position": 120 + }, { "type": "label", "name": "iconClass", diff --git a/docs/User Guide/User Guide/Note Types/Markdown.md b/docs/User Guide/User Guide/Note Types/Markdown.md index 4913eb5f83..906645611e 100644 --- a/docs/User Guide/User Guide/Note Types/Markdown.md +++ b/docs/User Guide/User Guide/Note Types/Markdown.md @@ -25,7 +25,10 @@ Even if Markdown is now specially treated by having a preview mechanism, Trilium The following features are supported by Trilium's Markdown format and will show up in the preview pane: * All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes) -* Code blocks with syntax highlight (e.g. `mermaid` +* Code blocks with syntax highlight (e.g. ` ```js `) and automatic syntax highlight +* Block quotes & admonitions +* Math Equations +* Mermaid Diagrams using ` ```mermaid ` * Include Note (no builtin Markdown syntax, but HTML syntax works just fine): ``` @@ -52,7 +55,6 @@ There are two ways to create a Markdown note: ## Import/export * By default, when importing a single Markdown file it automatically gets converted to a Text note. To avoid that and have it imported as a Markdown note instead: - * Right click the Note Tree and select _Import into note_. * Select the file normally. * Uncheck _Import HTML, Markdown and TXT as text notes if it's unclear from the metadata_. diff --git a/docs/User Guide/User Guide/Note Types/Text/Insert buttons.md b/docs/User Guide/User Guide/Note Types/Text/Insert buttons.md index cc7d42c602..39c18dd787 100644 --- a/docs/User Guide/User Guide/Note Types/Text/Insert buttons.md +++ b/docs/User Guide/User Guide/Note Types/Text/Insert buttons.md @@ -3,7 +3,7 @@ Press the button i ## Bookmarks -See the dedicated Bookmarks section. +See the dedicated Anchors section. ## Emoji