The_Great_Archive/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2026-09-12 19:50:20 +05:00
Code Issues Actions 18 Packages Projects Releases Wiki Activity

docs: update

Browse Source
This commit is contained in:
Adorian Doran 2026-07-17 23:38:18 +03:00
parent bd90f03a83
commit 9ea457cf8d
18 changed files with 21800 additions and 284 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json
View File

File diff suppressed because one or more lines are too long

120
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Customizing to-do task states.html
View File

@ -11,68 +11,66 @@
<h2>Editing a task state</h2>
<p>Selecting any state other than "None" and "Done" (which cannot be modified)
from the side pane reveals the following editable fields:</p>
<figure class="table">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Icon</strong> (required)</td>
<td>The symbol shown inside the checkbox. You can pick an icon just as you
would for any regular note, including from custom icon packs.</td>
</tr>
<tr>
<td><strong>Title</strong> (required)</td>
<td>The name of the task state shown in the UI. For example: "Doing", "Postponed".</td>
</tr>
<tr>
<td><strong>Identifier</strong> (required)</td>
<td>
<p>A short name for the state, using only letters, digits, "-" and "_". It
is stored as metadata in the note's markup and used to identify the task
state. Two task states cannot share the same identifier.</p>
<aside class="admonition warning">
<p><span style="background-color:color(srgb0.8862750.6666670.0117647/0.15);color:rgb(204,204,204);">Prefix the identifiers of your custom task states with an underscore (</span>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Icon</strong> (required)</td>
<td>The symbol shown inside the checkbox. You can pick an icon just as you
would for any regular note, including from custom icon packs.</td>
</tr>
<tr>
<td><strong>Title</strong> (required)</td>
<td>The name of the task state shown in the UI. For example: "Doing", "Postponed".</td>
</tr>
<tr>
<td><strong>Identifier</strong> (required)</td>
<td>
<p>A short name for the state, using only letters, digits, "-" and "_". It
is stored as metadata in the note's markup and used to identify the task
state. Two task states cannot share the same identifier.</p>
<aside class="admonition warning">
<p><span style="color:rgb(204,204,204)">Prefix the identifiers of your custom task states with an underscore (</span>
<code
spellcheck="false">_</code><span style="color:rgb(204,204,204)">) or a hyphen (</span>
<code
spellcheck="false">_</code><span style="background-color:color(srgb0.8862750.6666670.0117647/0.15);color:rgb(204,204,204);">) or a hyphen (</span>
<code
spellcheck="false">-</code><span style="background-color:color(srgb0.8862750.6666670.0117647/0.15);color:rgb(204,204,204);">) to avoid clashes with task states that may be introduced in future versions of Trilium.</span>
</p>
</aside>
</td>
</tr>
<tr>
<td><strong>Markdown symbol</strong>
</td>
<td>A single character used to represent the state in Markdown syntax. For
example, "#" creates a task state that can be applied in Markdown using
" - [#] ". Make sure no other task state uses the same symbol.</td>
</tr>
<tr>
<td><strong>Counts as completed</strong>
</td>
<td>If checked, the task is treated as completed.</td>
</tr>
<tr>
<td><strong>Color</strong>
</td>
<td>The color of the checkbox. Its lightness and saturation are adjusted automatically
to match the current color scheme or theme.</td>
</tr>
<tr>
<td><strong>Hidden from toolbar</strong>
</td>
<td>The state is not listed in the UI. This is useful when you want existing
notes to keep rendering the state correctly but no longer need to apply
it yourself.</td>
</tr>
</tbody>
</table>
</figure>
spellcheck="false">-</code><span style="color:rgb(204,204,204)">) to avoid clashes with task states that may be introduced in future versions of Trilium.</span>
</p>
</aside>
</td>
</tr>
<tr>
<td><strong>Markdown symbol</strong>
</td>
<td>A single character used to represent the state in Markdown syntax. For
example, "#" creates a task state that can be applied in Markdown using
" - [#] ". Make sure no other task state uses the same symbol.</td>
</tr>
<tr>
<td><strong>Counts as completed</strong>
</td>
<td>If checked, the task is treated as completed.</td>
</tr>
<tr>
<td><strong>Color</strong>
</td>
<td>The color of the checkbox. Its lightness and saturation are adjusted automatically
to match the current color scheme or theme.</td>
</tr>
<tr>
<td><strong>Hidden from toolbar</strong>
</td>
<td>The state is not listed in the UI. This is useful when you want existing
notes to keep rendering the state correctly but no longer need to apply
it yourself.</td>
</tr>
</tbody>
</table>
<aside class="admonition note">
<p>The task definition details are validated at startup. If errors are found,
a toast provides the details and the affected task definition is ignored.</p>

2
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html
View File

@ -81,7 +81,7 @@
<td><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>
</td>
<td>Displays the children of the note either as a grid, a list, or for a more
specialized case: a calendar.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
specialized case: a calendar.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>
<br>Generally useful for easy reading of short notes.</td>
</tr>

2
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Converting Between Note Types.html
View File

@ -19,7 +19,7 @@
<p>Since Markdown does not support all the capabilities of Text notes, this
conversion is lossy in terms of formatting: some formatting may be lost,
and some unsupported elements may even be dropped. It's strongly recommended
for you inspect the content for any information that might have gone missing
that you inspect the content for any information that might have gone missing
after the conversion.</p>
</aside>
<p>To convert a text note to Markdown, go to the note menu → <strong>“Advanced”</strong> and

347
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html
View File

@ -20,178 +20,175 @@
<p>Fore more information see&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</p>
<h2>Features and formatting</h2>
<p>Here's a list of various features supported by text notes:</p>
<figure
class="table">
<table>
<thead>
<tr>
<th>Dedicated article</th>
<th>Feature</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="reference-link" href="#root/_help_Gr6xFaF6ioJ5">General formatting</a>
</td>
<td>
<ul>
<li>Headings (section titles, paragraph)</li>
<li>Font size</li>
<li>Bold, italic, underline, strike-through</li>
<li>Superscript, subscript</li>
<li>Font color &amp; background color</li>
<li>Remove formatting</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_S6Xx8QIWTV66">Lists</a>
</td>
<td>
<ul>
<li>Bulleted lists</li>
<li>Numbered lists</li>
<li>To-do lists</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_NwBbFdNZ9h7O">Block quotes &amp; admonitions</a>
</td>
<td>
<ul>
<li>Block quotes</li>
<li>Admonitions</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_NdowYOC1GFKS">Tables</a>
</td>
<td>
<ul>
<li>Basic tables</li>
<li>Merging cells</li>
<li>Styling tables and cells.</li>
<li>Table captions</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_UYuUB1ZekNQU">Developer-specific formatting</a>
</td>
<td>
<ul>
<li>Inline code</li>
<li>Code blocks</li>
<li>Keyboard shortcuts</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_AgjCISero73a">Footnotes</a>
</td>
<td>
<ul>
<li>Footnotes</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_mT0HEkOsz6i1">Images</a>
</td>
<td>
<ul>
<li>Images</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_QEAPj01N5f7w">Links</a>
</td>
<td>
<ul>
<li>External links</li>
<li>Internal Trilium links</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a>
</td>
<td>
<ul>
<li>Include note</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_CohkqWQC1iBv">Insert buttons</a>
</td>
<td>
<ul>
<li>Symbols</li>
<li><a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a>
</li>
<li>Mermaid diagrams</li>
<li>Horizontal ruler</li>
<li>Page break</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_dEHYtoWWi8ct">Other features</a>
</td>
<td>
<ul>
<li>Indentation
<ul>
<li>Markdown import</li>
</ul>
</li>
<li><a class="reference-link" href="#root/_help_2x0ZAX9ePtzV">Cut to subnote</a>
</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_gLt3vA97tMcp">Premium features</a>
</td>
<td>
<ul>
<li><a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>
</li>
<li><a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>
</li>
<li><a class="reference-link" href="#root/_help_5wZallV2Qo1t">Format Painter</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</figure>
<h2>Read-Only vs. Editing Mode</h2>
<p>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&nbsp;<a class="reference-link"
href="#root/_help_CoFPLs3dRlXc">Read-Only Notes</a>.</p>
<h2>Keyboard shortcuts</h2>
<p>There are numerous keyboard shortcuts to format the text without having
to use the mouse. For a reference of all the key combinations, see&nbsp;
<a
class="reference-link" href="#root/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a>. In addition, see&nbsp;<a class="reference-link"
href="#root/_help_QrtTYPmdd1qq">Markdown-like formatting</a>&nbsp;as an alternative
to the keyboard shortcuts.</p>
<h2>Content width</h2>
<p>For readability purposes on wider screens, the width of text notes is
limited via a configurable option. See&nbsp;<a class="reference-link" href="#root/_help_t596jLvPrqkS">Content width</a>&nbsp;for
more information.</p>
<h2>Converting to a Markdown note</h2>
<p>Text notes can be converted to&nbsp;<a class="reference-link" href="#root/_help_6RM1Q7ppFVoj">Markdown</a>&nbsp;notes.
See&nbsp;<a class="reference-link" href="#root/_help_jludwdW7N4hg">Converting between note types</a>.</p>
<h2>Technical details</h2>
<p>For the text editing functionality, Trilium uses a commercial product
(with an open-source base) called&nbsp;<a class="reference-link" href="#root/_help_MI26XDLSAlCD">CKEditor</a>.
This brings the benefit of having a powerful WYSIWYG (What You See Is What
You Get) editor.</p>
<table>
<thead>
<tr>
<th>Dedicated article</th>
<th>Feature</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="reference-link" href="#root/_help_Gr6xFaF6ioJ5">General formatting</a>
</td>
<td>
<ul>
<li>Headings (section titles, paragraph)</li>
<li>Font size</li>
<li>Bold, italic, underline, strike-through</li>
<li>Superscript, subscript</li>
<li>Font color &amp; background color</li>
<li>Remove formatting</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_S6Xx8QIWTV66">Lists</a>
</td>
<td>
<ul>
<li>Bulleted lists</li>
<li>Numbered lists</li>
<li>To-do lists</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_NwBbFdNZ9h7O">Block quotes &amp; admonitions</a>
</td>
<td>
<ul>
<li>Block quotes</li>
<li>Admonitions</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_NdowYOC1GFKS">Tables</a>
</td>
<td>
<ul>
<li>Basic tables</li>
<li>Merging cells</li>
<li>Styling tables and cells.</li>
<li>Table captions</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_UYuUB1ZekNQU">Developer-specific formatting</a>
</td>
<td>
<ul>
<li>Inline code</li>
<li>Code blocks</li>
<li>Keyboard shortcuts</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_AgjCISero73a">Footnotes</a>
</td>
<td>
<ul>
<li>Footnotes</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_mT0HEkOsz6i1">Images</a>
</td>
<td>
<ul>
<li>Images</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_QEAPj01N5f7w">Links</a>
</td>
<td>
<ul>
<li>External links</li>
<li>Internal Trilium links</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a>
</td>
<td>
<ul>
<li>Include note</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_CohkqWQC1iBv">Insert buttons</a>
</td>
<td>
<ul>
<li>Symbols</li>
<li><a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a>
</li>
<li>Mermaid diagrams</li>
<li>Horizontal ruler</li>
<li>Page break</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_dEHYtoWWi8ct">Other features</a>
</td>
<td>
<ul>
<li>Indentation
<ul>
<li>Markdown import</li>
</ul>
</li>
<li><a class="reference-link" href="#root/_help_2x0ZAX9ePtzV">Cut to subnote</a>
</li>
</ul>
</td>
</tr>
<tr>
<td><a class="reference-link" href="#root/_help_gLt3vA97tMcp">Premium features</a>
</td>
<td>
<ul>
<li><a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>
</li>
<li><a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>
</li>
<li><a class="reference-link" href="#root/_help_5wZallV2Qo1t">Format Painter</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<h2>Read-Only vs. Editing Mode</h2>
<p>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&nbsp;<a class="reference-link"
href="#root/_help_CoFPLs3dRlXc">Read-Only Notes</a>.</p>
<h2>Keyboard shortcuts</h2>
<p>There are numerous keyboard shortcuts to format the text without having
to use the mouse. For a reference of all the key combinations, see&nbsp;
<a
class="reference-link" href="#root/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a>. In addition, see&nbsp;<a class="reference-link"
href="#root/_help_QrtTYPmdd1qq">Markdown-like formatting</a>&nbsp;as an alternative
to the keyboard shortcuts.</p>
<h2>Content width</h2>
<p>For readability purposes on wider screens, the width of text notes is
limited via a configurable option. See&nbsp;<a class="reference-link" href="#root/_help_t596jLvPrqkS">Content width</a>&nbsp;for
more information.</p>
<h2>Converting to a Markdown note</h2>
<p>Text notes can be converted to&nbsp;<a class="reference-link" href="#root/_help_6RM1Q7ppFVoj">Markdown</a>&nbsp;notes.
See&nbsp;<a class="reference-link" href="#root/_help_jludwdW7N4hg">Converting between note types</a>.</p>
<h2>Technical details</h2>
<p>For the text editing functionality, Trilium uses a commercial product
(with an open-source base) called&nbsp;<a class="reference-link" href="#root/_help_MI26XDLSAlCD">CKEditor</a>.
This brings the benefit of having a powerful WYSIWYG (What You See Is What
You Get) editor.</p>

66
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Link Previews.html
View File

@ -17,40 +17,38 @@
</ul>
</li>
</ul>
<figure class="table">
<table class="ck-table-resized">
<colgroup>
<col style="width:21.85%;">
<col style="width:38.84%;">
<col style="width:39.31%;">
</colgroup>
<tbody>
<tr>
<td>
<figure class="image image_resized" style="width:100%;">
<img style="aspect-ratio:251/42;" src="Link Previews_image.png"
width="251" height="42">
<figcaption><em>Inline</em> link preview</figcaption>
</figure>
</td>
<td>
<figure class="image image_resized" style="width:100%;">
<img style="aspect-ratio:1217/196;" src="2_Link Previews_image.png"
width="1217" height="196">
<figcaption><em>Card</em> link preview</figcaption>
</figure>
</td>
<td>
<figure class="image image_resized" style="width:100%;">
<img style="aspect-ratio:994/563;" src="1_Link Previews_image.png"
width="994" height="563">
<figcaption><em>Embed</em> link preview</figcaption>
</figure>
</td>
</tr>
</tbody>
</table>
</figure>
<table class="ck-table-resized">
<colgroup>
<col style="width:21.85%;">
<col style="width:38.84%;">
<col style="width:39.31%;">
</colgroup>
<tbody>
<tr>
<td>
<figure class="image image_resized" style="width:100%;">
<img style="aspect-ratio:251/42;" src="Link Previews_image.png"
width="251" height="42">
<figcaption><em>Inline</em> link preview</figcaption>
</figure>
</td>
<td>
<figure class="image image_resized" style="width:100%;">
<img style="aspect-ratio:1217/196;" src="2_Link Previews_image.png"
width="1217" height="196">
<figcaption><em>Card</em> link preview</figcaption>
</figure>
</td>
<td>
<figure class="image image_resized" style="width:100%;">
<img style="aspect-ratio:994/563;" src="1_Link Previews_image.png"
width="994" height="563">
<figcaption><em>Embed</em> link preview</figcaption>
</figure>
</td>
</tr>
</tbody>
</table>
<h2>Inserting a link preview</h2>
<p>There are two ways to create one:</p>
<h3>1. By pasting a URL</h3>

2
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.html
View File

@ -4,7 +4,7 @@
</figure>
<aside class="admonition note">
<p>This is a premium feature of the editor we are using (CKEditor) and we
benefit from it thanks to an written agreement with the team. See&nbsp;&nbsp;
benefit from it thanks to a written agreement with the team. See&nbsp;&nbsp;
<a
class="reference-link" href="#root/_help_gLt3vA97tMcp">Premium features</a>&nbsp;for more information.</p>
</aside>

1
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development.html
View File

@ -1 +0,0 @@
<p>i</p>

2
apps/standalone/src/assets/help_meta.json
View File

File diff suppressed because one or more lines are too long

21501
docs/User Guide/!!!meta.json Normal file
View File

File diff suppressed because it is too large Load Diff

25
docs/User Guide/User Guide.md Normal file
View File

@ -0,0 +1,25 @@
# User Guide
Trilium is an open-source solution for note-taking and organizing a personal knowledge base. Use it locally on your desktop, or sync it with your self-hosted server to keep your notes everywhere you go.
> [!TIP]
> The same documentation can be accessed locally from within the Trilium Notes application by pressing <kbd>F1</kbd>.
## Getting started
1. See <a class="reference-link" href="User%20Guide/Quick%20Start.md">Quick Start</a>.
2. Go through <a class="reference-link" href="User%20Guide/Basic%20Concepts%20and%20Features">Basic Concepts and Features</a>.
3. Understand <a class="reference-link" href="User%20Guide/Basic%20Concepts%20and%20Features/Notes.md">Notes</a>.
4. Browse through <a class="reference-link" href="User%20Guide/Collections.md">Collections</a>.
## Quick links
* <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
* <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
* <a class="reference-link" href="User%20Guide/Scripting/Script%20API/Frontend%20API">Frontend API</a> or <a class="reference-link" href="User%20Guide/Scripting/Script%20API/Backend%20API.dat">Backend API</a>
* [ETAPI reference](User%20Guide/Advanced%20Usage/ETAPI%20\(REST%20API\)/API%20Reference.dat)
## External links
* The [Trilium Notes website](https://triliumnotes.org/), for a quick presentation of the application.
* [Developer Guide](https://docs.triliumnotes.org/developer-guide/), to understand the architecture and processes behind the development of Trilium Notes.
* [GitHub Repository (TriliumNext/Trilium)](https://github.com/TriliumNext/Trilium/)

2
docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md
View File

@ -53,7 +53,7 @@ This is a list of labels that Trilium natively supports.
| `readOnly` | Marks a note to always be [read-only](../../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.md), if it's a supported note (text, code, mermaid). |
| `autoReadOnlyDisabled` | Disables automatic [read-only mode](../../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.md) for the given note. |
| `appCss` | Marks CSS notes which are loaded into the Trilium application and can thus be used to modify Trilium's looks. See <a class="reference-link" href="../../Theme%20development/Custom%20app-wide%20CSS.md">Custom app-wide CSS</a> for more info. |
| `appTheme` | Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See <a class="reference-link" href="../../Theme%20development.md">Theme development</a> for more information. |
| `appTheme` | Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See <a class="reference-link" href="../../Theme%20development">Theme development</a> for more information. |
| `appThemeBase` | Set to `next`, `next-light`, or `next-dark` to use the corresponding TriliumNext theme (auto, light or dark) as the base for a custom theme, instead of the legacy one. See <a class="reference-link" href="../../Theme%20development/Customize%20the%20Next%20theme.md">Customize the Next theme</a> for more information. |
| `cssClass` | Value of this label is then added as CSS class to the node representing given note in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>. This can be useful for advanced theming. Can be used in template notes. |
| `iconClass` | value of this label is added as a CSS class to the icon on the tree which can help visually distinguish the notes in the tree. Example might be bx bx-home - icons are taken from boxicons. Can be used in template notes. |

2
docs/User Guide/User Guide/Advanced Usage/Customizing to-do task states.md
View File

@ -30,7 +30,7 @@ Selecting any state other than "None" and "Done" (which cannot be modified) from
</tr>
<tr>
<td><strong>Identifier</strong> (required)</td>
<td><p>A short name for the state, using only letters, digits, "-" and "_". It is stored as metadata in the note's markup and used to identify the task state. Two task states cannot share the same identifier.</p><aside class="admonition warning"><p><span style="background-color:color(srgb0.8862750.6666670.0117647/0.15);color:rgb(204,204,204);">Prefix the identifiers of your custom task states with an underscore (</span><code spellcheck="false">_</code><span style="background-color:color(srgb0.8862750.6666670.0117647/0.15);color:rgb(204,204,204);">) or a hyphen (</span><code spellcheck="false">-</code><span style="background-color:color(srgb0.8862750.6666670.0117647/0.15);color:rgb(204,204,204);">) to avoid clashes with task states that may be introduced in future versions of Trilium.</span></p></aside></td>
<td><p>A short name for the state, using only letters, digits, "-" and "_". It is stored as metadata in the note's markup and used to identify the task state. Two task states cannot share the same identifier.</p><aside class="admonition warning"><p><span style="color:rgb(204,204,204)">Prefix the identifiers of your custom task states with an underscore (</span><code spellcheck="false">_</code><span style="color:rgb(204,204,204)">) or a hyphen (</span><code spellcheck="false">-</code><span style="color:rgb(204,204,204)">) to avoid clashes with task states that may be introduced in future versions of Trilium.</span></p></aside></td>
</tr>
<tr>
<td><strong>Markdown symbol</strong></td>

2
docs/User Guide/User Guide/Basic Concepts and Features/Active content.md
View File

@ -23,7 +23,7 @@ These are the types of active content in Trilium, along with a few examples of w
| <a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a> | Yes | Displays a website inside a note. | Can point to a phishing website which can collect the data (for example on a log in page). |
| <a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a> | Yes | Renders custom content inside a note, such as a dashboard or a new editor that is not officially supported by Trilium. | Can affect the UI similar to front-end scripts or custom widgets since the scripts are not completely encapsulated, or they can act similar to a web view where they can collect data entered by the user. |
| <a class="reference-link" href="../Theme%20development/Custom%20app-wide%20CSS.md">Custom app-wide CSS</a> | No | Can alter the layout and style of the UI using CSS, applied regardless of theme. | Generally less problematic than the rest of active content, but a badly written CSS can affect the layout of the application, requiring the use of <a class="reference-link" href="../Advanced%20Usage/Safe%20mode.md">Safe mode</a> to be able to use the application. |
| [Custom themes](../Theme%20development.md) | No | Can change the style of the entire UI. | Similar to custom app-wide CSS. |
| [Custom themes](../Theme%20development) | No | Can change the style of the entire UI. | Similar to custom app-wide CSS. |
| <a class="reference-link" href="Themes/Icon%20Packs.md">Icon Packs</a> | No | Introduces new icons that can be used for notes. | Generally are more contained and less prone to cause issues, but they can cause performance issues (for example if the icon pack has millions of icons in it). |
## Active content badge

2
docs/User Guide/User Guide/Note Types.md
View File

@ -33,7 +33,7 @@ The following note types are supported by Trilium:
| <a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a> | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
| <a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a> | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
| <a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a> | Used in <a class="reference-link" href="Scripting.md">Scripting</a>, it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it. |
| <a class="reference-link" href="Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.       <br> <br>Generally useful for easy reading of short notes. |
| <a class="reference-link" href="Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.         <br> <br>Generally useful for easy reading of short notes. |
| <a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> | Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format. |
| <a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a> | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). |
| <a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a> | Displays the content of an external web page, similar to a browser. |

2
docs/User Guide/User Guide/Note Types/Converting between note types.md
View File

@ -17,7 +17,7 @@ To do so, go to the note menu → “**Advanced”** and select "**Convert to Te
### Text Note to Markdown
> [!WARNING]
> Since Markdown does not support all the capabilities of Text notes, this conversion is lossy in terms of formatting: some formatting may be lost, and some unsupported elements may even be dropped. It's strongly recommended for you inspect the content for any information that might have gone missing after the conversion.
> Since Markdown does not support all the capabilities of Text notes, this conversion is lossy in terms of formatting: some formatting may be lost, and some unsupported elements may even be dropped. It's strongly recommended that you inspect the content for any information that might have gone missing after the conversion.
To convert a text note to Markdown, go to the note menu → **“Advanced”** and select **"Convert to Markdown Note"**.

2
docs/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.md
View File

@ -2,7 +2,7 @@
<figure class="image image-style-align-right"><img style="aspect-ratio:265/108;" src="Text Snippets_image.png" width="265" height="108"></figure>
> [!NOTE]
> This is a premium feature of the editor we are using (CKEditor) and we benefit from it thanks to an written agreement with the team. See  <a class="reference-link" href="../Premium%20features.md">Premium features</a> for more information.
> This is a premium feature of the editor we are using (CKEditor) and we benefit from it thanks to a written agreement with the team. See  <a class="reference-link" href="../Premium%20features.md">Premium features</a> for more information.
Text Snippets are closely related to <a class="reference-link" href="../../../Advanced%20Usage/Templates.md">Templates</a>, but instead of defining the content of an entire note, text snippets are pieces of formatted text that can easily be inserted in a text note.

2
docs/User Guide/User Guide/Theme development.md
View File

@ -1,2 +0,0 @@
# Theme development
i