Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-07-28 10:32:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): sync

Browse Source
This commit is contained in:
Elian Doran 2025-04-12 00:14:00 +03:00
parent 2b53a1c534
commit 9c0c1bad2d
No known key found for this signature in database
9 changed files with 116 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
docs/User Guide/!!!meta.json
View File

@ -382,10 +382,24 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "l2VkvOwUNfZj", "value": "rWX5eY045zbE",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{
"type": "relation",
"name": "internalLink",
"value": "3tW6mORuTHnB",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "l2VkvOwUNfZj",
"isInheritable": false,
"position": 30
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -399,20 +413,6 @@
"value": "bx bx-code-alt", "value": "bx bx-code-alt",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "rWX5eY045zbE",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "3tW6mORuTHnB",
"isInheritable": false,
"position": 50
} }
], ],
"format": "markdown", "format": "markdown",
@ -475,35 +475,35 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "cbkrhQjrkKrh", "value": "J1Bb6lVlwU5T",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "3tW6mORuTHnB", "value": "cbkrhQjrkKrh",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "rWX5eY045zbE", "value": "3tW6mORuTHnB",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "moVgBcoxE3EK", "value": "rWX5eY045zbE",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "J1Bb6lVlwU5T", "value": "moVgBcoxE3EK",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
@ -4089,17 +4089,31 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "QEAPj01N5f7w", "value": "oiVPnW8QfnvS",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "QrtTYPmdd1qq",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "eIg8jdvaoNNd", "value": "QEAPj01N5f7w",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 70
}, },
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 80
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -4113,20 +4127,6 @@
"value": "bx bxs-keyboard", "value": "bx bxs-keyboard",
"isInheritable": false, "isInheritable": false,
"position": 80 "position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "oiVPnW8QfnvS",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "QrtTYPmdd1qq",
"isInheritable": false,
"position": 100
} }
], ],
"format": "markdown", "format": "markdown",
@ -6038,19 +6038,19 @@
"type": "text", "type": "text",
"mime": "text/html", "mime": "text/html",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "MI26XDLSAlCD",
"isInheritable": false,
"position": 10
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
"value": "bx bxs-keyboard", "value": "bx bxs-keyboard",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "MI26XDLSAlCD",
"isInheritable": false,
"position": 40
} }
], ],
"format": "markdown", "format": "markdown",

86
src/public/app/doc_notes/en/User Guide/!!!meta.json generated
View File

@ -382,10 +382,24 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "l2VkvOwUNfZj", "value": "rWX5eY045zbE",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{
"type": "relation",
"name": "internalLink",
"value": "3tW6mORuTHnB",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "l2VkvOwUNfZj",
"isInheritable": false,
"position": 30
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -399,20 +413,6 @@
"value": "bx bx-code-alt", "value": "bx bx-code-alt",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "rWX5eY045zbE",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "3tW6mORuTHnB",
"isInheritable": false,
"position": 50
} }
], ],
"format": "html", "format": "html",
@ -475,35 +475,35 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "cbkrhQjrkKrh", "value": "J1Bb6lVlwU5T",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "3tW6mORuTHnB", "value": "cbkrhQjrkKrh",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "rWX5eY045zbE", "value": "3tW6mORuTHnB",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "moVgBcoxE3EK", "value": "rWX5eY045zbE",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "J1Bb6lVlwU5T", "value": "moVgBcoxE3EK",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
@ -4089,17 +4089,31 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "QEAPj01N5f7w", "value": "oiVPnW8QfnvS",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "QrtTYPmdd1qq",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "eIg8jdvaoNNd", "value": "QEAPj01N5f7w",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 70
}, },
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 80
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -4113,20 +4127,6 @@
"value": "bx bxs-keyboard", "value": "bx bxs-keyboard",
"isInheritable": false, "isInheritable": false,
"position": 80 "position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "oiVPnW8QfnvS",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "QrtTYPmdd1qq",
"isInheritable": false,
"position": 100
} }
], ],
"format": "html", "format": "html",
@ -6038,19 +6038,19 @@
"type": "text", "type": "text",
"mime": "text/html", "mime": "text/html",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "MI26XDLSAlCD",
"isInheritable": false,
"position": 10
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
"value": "bx bxs-keyboard", "value": "bx bxs-keyboard",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "MI26XDLSAlCD",
"isInheritable": false,
"position": 40
} }
], ],
"format": "html", "format": "html",

4
src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Technologies used/CKEditor.html generated
View File

@ -54,8 +54,8 @@
</li> </li>
<li><a href="#root/_help_QEAPj01N5f7w">Reference links</a> <li><a href="#root/_help_QEAPj01N5f7w">Reference links</a>
</li> </li>
<li><a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_NwBbFdNZ9h7O">Admonitions</a>, <li><a href="#root/_help_NwBbFdNZ9h7O">Admonitions</a>, we ended up creating
we ended up creating our own plugin but <a href="https://github.com/aarkue/ckeditor5-admonition">aarkue/ckeditor5-admonition</a> was our own plugin but <a href="https://github.com/aarkue/ckeditor5-admonition">aarkue/ckeditor5-admonition</a> was
a good inspiration (including the toolbar icon).</li> a good inspiration (including the toolbar icon).</li>
</ul> </ul>
</div> </div>

6
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Keyboard Shortcuts.html generated
View File

@ -86,10 +86,10 @@
</ul> </ul>
<h2>Editing notes</h2> <h2>Editing notes</h2>
<ul> <ul>
<li>For&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a>&nbsp;notes, <li>For&nbsp;<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes,
refer to&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_oiVPnW8QfnvS">Keyboard shortcuts</a>&nbsp;and&nbsp; refer to&nbsp;<a class="reference-link" href="#root/_help_oiVPnW8QfnvS">Keyboard shortcuts</a>&nbsp;and&nbsp;
<a <a
class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_QrtTYPmdd1qq">Markdown-like formatting</a>.</li> 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 <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 keys <kbd><span>←</span></kbd>,<kbd><span>→</span></kbd> to navigate, <kbd>Enter</kbd> to
apply)</li> apply)</li>

6
src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manually.html generated
View File

@ -14,10 +14,10 @@
<div class="ck-content"> <div class="ck-content">
<aside class="admonition warning"> <aside class="admonition warning">
<p>This page describes manually installing Trilium on your server. <strong>Note that this is a not well supported way to install Trilium, problems may appear, information laid out here is quite out of date. It is recommended to use either&nbsp;</strong> <p>This page describes manually installing Trilium on your server. <strong>Note that this is a not well supported way to install Trilium, problems may appear, information laid out here is quite out of date. It is recommended to use either</strong>&nbsp;
<a <a
class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/WOcw2SLH6tbX/Dgg7bR3b6K9j/_help_rWX5eY045zbE">Docker Server Installation</a><strong>&nbsp;or&nbsp;</strong><a class="reference-link" class="reference-link" href="#root/_help_rWX5eY045zbE">Docker Server Installation</a>&nbsp;<strong>or</strong>&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/WOcw2SLH6tbX/Dgg7bR3b6K9j/_help_3tW6mORuTHnB">Packaged server installation</a><strong>.</strong> href="#root/_help_3tW6mORuTHnB">Packaged server installation</a><strong>.</strong>
</p> </p>
</aside> </aside>
<h2>Requirements</h2> <h2>Requirements</h2>

23
src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Multiple server instances.html generated
View File

@ -15,24 +15,27 @@
<div class="ck-content"> <div class="ck-content">
<p>Trilium does not support multiple users. In order to have two or more <p>Trilium does not support multiple users. In order to have two or more
persons with their own set of notes, multiple server instances must be persons with their own set of notes, multiple server instances must be
set up. It is also not possible to use multiple <a href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_cbkrhQjrkKrh">sync</a> servers.</p> set up. It is also not possible to use multiple <a href="#root/_help_cbkrhQjrkKrh">sync</a> servers.</p>
<p>To allow multiple server instances on a single physical server:</p> <p>To allow multiple server instances on a single physical server:</p>
<ul> <ul>
<li> <li>
<p>For&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/WOcw2SLH6tbX/Dgg7bR3b6K9j/_help_3tW6mORuTHnB">Packaged version for Linux</a>&nbsp;or&nbsp; <p>For&nbsp;<a class="reference-link" href="#root/_help_3tW6mORuTHnB">Packaged version for Linux</a>&nbsp;or&nbsp;
<a <a
class="reference-link" href="#root/Dgg7bR3b6K9j/_help_J1Bb6lVlwU5T">Manually</a>, if starting the server manually just specify a different class="reference-link" href="#root/_help_J1Bb6lVlwU5T">Manually</a>, if starting the server manually just specify a different
port and data directory per instance:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_NETWORK_PORT=8080 TRILIUM_DATA_DIR=/path/to/your/data-dir-A /opt/trilium/trilium.sh</code></pre> port and data directory per instance:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_NETWORK_PORT=8080 TRILIUM_DATA_DIR=/path/to/your/data-dir-A /opt/trilium/trilium.sh</code></pre>
<p>For a second instance:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_NETWORK_PORT=8081 TRILIUM_DATA_DIR=/path/to/your/data-dir-B /opt/trilium/trilium.sh</code></pre> <p>For a second instance:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_NETWORK_PORT=8081 TRILIUM_DATA_DIR=/path/to/your/data-dir-B /opt/trilium/trilium.sh</code></pre>
<p>If using <code>systemd</code>, then set the <a href="https://serverfault.com/questions/413397/how-to-set-environment-variable-in-systemd-service">environment variables in the service configuration</a>.</p> <p>If using <code>systemd</code>, then set the <a href="https://serverfault.com/questions/413397/how-to-set-environment-variable-in-systemd-service">environment variables in the service configuration</a>.</p>
<p>&nbsp;</p>
</li> </li>
<li>For&nbsp;<a class="reference-link" href="#root/Dgg7bR3b6K9j/_help_rWX5eY045zbE">Using Docker</a>, <li>
simply use two different containers, each with their own port binding and <p>For&nbsp;<a class="reference-link" href="#root/_help_rWX5eY045zbE">Using Docker</a>,
data directory.</li> simply use two different containers, each with their own port binding and
<li>For&nbsp;<a class="reference-link" href="#root/Dgg7bR3b6K9j/_help_moVgBcoxE3EK">On NixOS</a>, data directory.</p>
the only possible way is to use Docker OCI containers or at least one NixOS </li>
container with its own service definition.</li> <li>
<p>For&nbsp;<a class="reference-link" href="#root/_help_moVgBcoxE3EK">On NixOS</a>,
the only possible way is to use Docker OCI containers or at least one NixOS
container with its own service definition.</p>
</li>
</ul> </ul>
<p>For support or additional context, see the related <a href="https://github.com/orgs/TriliumNext/discussions/1642#discussioncomment-12768808">GitHub Discussion</a>.</p> <p>For support or additional context, see the related <a href="https://github.com/orgs/TriliumNext/discussions/1642#discussioncomment-12768808">GitHub Discussion</a>.</p>
</div> </div>

2
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.html generated
View File

@ -69,7 +69,7 @@
section.</li> section.</li>
</ul> </ul>
<aside class="admonition note"> <aside class="admonition note">
<p><strong>Context regarding syntax highlighting</strong> <p><strong>Context regarding syntax highlighting</strong>
</p> </p>
<p>In order to achieve the syntax highlight, the Highlight.js library is <p>In order to achieve the syntax highlight, the Highlight.js library is
being used. Do note that support for syntax highlighting in code blocks being used. Do note that support for syntax highlighting in code blocks

10
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Keyboard shortcuts.html generated
View File

@ -16,8 +16,8 @@
<aside class="admonition tip"> <aside class="admonition tip">
<p>This section of keyboard shortcuts presents a subset of the keyboard shortcuts <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" as supported by the editor technology we are using,&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/1YeN2MzFUluU/_help_MI26XDLSAlCD">CKEditor</a>. href="#root/_help_MI26XDLSAlCD">CKEditor</a>. The shortcuts were taken
The shortcuts were taken from the <a href="https://ckeditor.com/docs/ckeditor5/latest/features/accessibility.html#keyboard-shortcuts">official documentation</a>. from the <a href="https://ckeditor.com/docs/ckeditor5/latest/features/accessibility.html#keyboard-shortcuts">official documentation</a>.
Note that not all the shortcuts in the original documentation are applicable Note that not all the shortcuts in the original documentation are applicable
(due to using a different configuration).</p> (due to using a different configuration).</p>
</aside> </aside>
@ -170,7 +170,8 @@
</tbody> </tbody>
</table> </table>
</figure> </figure>
<h3>Interacting with blocks</h3>
<h3>Interacting with blocks</h3>
<p>Blocks are images, tables, blockquotes, annotations.</p> <p>Blocks are images, tables, blockquotes, annotations.</p>
<figure class="table"> <figure class="table">
<table> <table>
@ -283,7 +284,8 @@
</tbody> </tbody>
</table> </table>
</figure> </figure>
<h3>General UI shortcuts</h3>
<h3>General UI shortcuts</h3>
<figure class="table"> <figure class="table">
<table> <table>
<thead> <thead>

4
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations.html generated
View File

@ -41,8 +41,8 @@
the official documentation.</p> the official documentation.</p>
<h2>Markdown support</h2> <h2>Markdown support</h2>
<p>Math equations will be preserved when exporting to or importing from Markdown, <p>Math equations will be preserved when exporting to or importing from Markdown,
surrounded by <code><span class="math-tex">\(</span></code> characters for surrounded by <code>\(</code> characters for inline math expressions, and <code>$\)</code> for
inline math expressions, and <code>$\)</code> for display mode.</p> display mode.</p>
<p>If you notice any issue with the Markdown import/export for equations, <p>If you notice any issue with the Markdown import/export for equations,
feel free to <a href="#root/_help_wy8So3yZZlH9">report</a> it while providing feel free to <a href="#root/_help_wy8So3yZZlH9">report</a> it while providing
the equation that causes issues.</p> the equation that causes issues.</p>