gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-20 07:08:55 +02:00
Code Issues Actions 18 Packages Projects Releases Wiki Activity

docs(user): document a few gaps

Browse Source
This commit is contained in:
Elian Doran 2025-09-29 23:33:53 +03:00
parent f7a565ec73
commit d611591e1a
No known key found for this signature in database
29 changed files with 399 additions and 340 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html generated vendored
View File

@ -1,6 +1,11 @@
<p>Trilium supports configuration via a file named <code>config.ini</code> and <p>Trilium supports configuration via a file named <code>config.ini</code> and
environment variables. This document provides a comprehensive reference environment variables. This document provides a comprehensive reference
for all configuration options.</p> for all configuration options.</p>
<h2>Location of the configuration file</h2>
<p>The configuration file is not located in the same directory as the application.
Instead, the <code>config.ini</code> is located in the&nbsp;<a class="reference-link"
href="#root/_help_tAassRL4RSQL">Data directory</a>. As such, the configuration
file is only available after starting the application and creating a database.</p>
<h2>Configuration Precedence</h2> <h2>Configuration Precedence</h2>
<p>Configuration values are loaded in the following order of precedence (highest <p>Configuration values are loaded in the following order of precedence (highest
to lowest):</p> to lowest):</p>

132
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html generated vendored
View File

@ -6,19 +6,22 @@ class="image">
<img style="aspect-ratio:1144/660;" src="Sharing_image.png" width="1144" <img style="aspect-ratio:1144/660;" src="Sharing_image.png" width="1144"
height="660"> height="660">
</figure> </figure>
<h2>Features, interaction and limitations</h2> <h2>Features, interaction and limitations</h2>
<ul> <ul>
<li>Searching by note title.</li> <li data-list-item-id="e865d86fdfe94260d08e3631d5b36047f">Searching by note title.</li>
<li>Automatic dark/light mode based on the user's browser settings.</li> <li data-list-item-id="e13b5deb15035a950c34a64d66ca76459">Automatic dark/light mode based on the user's browser settings.</li>
<li>Mobile-friendly layout, with sidebar.</li> <li
<li>Collapsible tree with the same note icons as the application.</li> data-list-item-id="eae144f08e29157dad576c0011d14f99d">Mobile-friendly layout, with sidebar.</li>
<li>Customizable logo.</li> <li data-list-item-id="e25712924a5a1322c8b903f832475bf0a">Collapsible tree with the same note icons as the application.</li>
<li>Toggle button for dark/light mode, which also stores the user preferences.</li> <li
<li>Quick navigation buttons (previous and next note).</li> data-list-item-id="ed9e131634923af3f9811002b4efb6f83">Customizable logo.</li>
<li>Displaying the date of the last update of the note.</li> <li data-list-item-id="ef52ad44bbd9f39ac8884848c8ac94c02">Toggle button for dark/light mode, which also stores the user preferences.</li>
<li
data-list-item-id="e80f263d244ef7c4ecdff6b5d08804eab">Quick navigation buttons (previous and next note).</li>
<li data-list-item-id="e2db5592f720a18e9609e2d97ab687bf1">Displaying the date of the last update of the note.</li>
</ul> </ul>
<h3>By note type</h3> <h3>By note type</h3>
<figure class="table">
<table class="ck-table-resized"> <table class="ck-table-resized">
<colgroup> <colgroup>
<col style="width:19.92%;"> <col style="width:19.92%;">
@ -38,16 +41,16 @@ class="image">
</th> </th>
<td> <td>
<ul> <ul>
<li>Table of contents.</li> <li data-list-item-id="e26b4ce9ba4e9dfe224d04e0f341925ed">Table of contents.</li>
<li>Syntax highlight of code blocks, provided a language is selected (does <li data-list-item-id="e9707fdfa2c92d66690cf932f7e647253">Syntax highlight of code blocks, provided a language is selected (does
not work if “Auto-detected” is enabled).</li> not work if “Auto-detected” is enabled).</li>
<li>Rendering for math equations.</li> <li data-list-item-id="e84420a10c6d64bd107edb6e867c91d4b">Rendering for math equations.</li>
</ul> </ul>
</td> </td>
<td> <td>
<ul> <ul>
<li>Including notes is not supported.</li> <li data-list-item-id="ecbc365d4886911af8859ccd0e1bbc465">Including notes is not supported.</li>
<li>Inline Mermaid diagrams are not rendered.</li> <li data-list-item-id="e41cc4139377f9f88d653d1eb8ca47bb4">Inline Mermaid diagrams are not rendered.</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@ -56,12 +59,12 @@ class="image">
</th> </th>
<td> <td>
<ul> <ul>
<li>Basic support (displaying the contents of the note in a monospace font).</li> <li data-list-item-id="e291ae6d5130677b4c99f7c3bdbe974b4">Basic support (displaying the contents of the note in a monospace font).</li>
</ul> </ul>
</td> </td>
<td> <td>
<ul> <ul>
<li>No syntax highlight.</li> <li data-list-item-id="e0270680bbdd7a129306e61e11691e36d">No syntax highlight.</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@ -94,12 +97,12 @@ class="image">
</th> </th>
<td> <td>
<ul> <ul>
<li>The child notes are displayed in a fixed format.&nbsp;</li> <li data-list-item-id="ea031e1d4149eb443ace756234490c5a4">The child notes are displayed in a fixed format.&nbsp;</li>
</ul> </ul>
</td> </td>
<td> <td>
<ul> <ul>
<li>More advanced view types such as the calendar view are not supported.</li> <li data-list-item-id="ea4a9d424aec2afbaecc07bbf64b7bebd">More advanced view types such as the calendar view are not supported.</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@ -108,12 +111,12 @@ class="image">
</th> </th>
<td> <td>
<ul> <ul>
<li>The diagram is displayed as a vector image.</li> <li data-list-item-id="e582d283f2b1b30cbe5ae35d8e01b2bf2">The diagram is displayed as a vector image.</li>
</ul> </ul>
</td> </td>
<td> <td>
<ul> <ul>
<li>No further interaction supported.</li> <li data-list-item-id="e33268686446e3c217077201bb5964364">No further interaction supported.</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@ -122,12 +125,12 @@ class="image">
</th> </th>
<td> <td>
<ul> <ul>
<li>The diagram is displayed as a vector image.</li> <li data-list-item-id="e443dd0e97c30cb12c77e8906a71569ea">The diagram is displayed as a vector image.</li>
</ul> </ul>
</td> </td>
<td> <td>
<ul> <ul>
<li>No further interaction supported.</li> <li data-list-item-id="efe151ef3f3826c825416417525fb5fb2">No further interaction supported.</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@ -143,7 +146,7 @@ class="image">
<td>The diagram is displayed as a vector image.</td> <td>The diagram is displayed as a vector image.</td>
<td> <td>
<ul> <ul>
<li>No further interaction supported.</li> <li data-list-item-id="ed3b4fb473042f6e32b4502d4fa11a767">No further interaction supported.</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@ -159,28 +162,30 @@ class="image">
<td>Basic interaction (downloading the file).</td> <td>Basic interaction (downloading the file).</td>
<td> <td>
<ul> <ul>
<li>No further interaction supported.</li> <li data-list-item-id="ed87e836a39d127ebcbb33e9e59045afb">No further interaction supported.</li>
</ul> </ul>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</figure>
<p>While the sharing feature is powerful, it has some limitations:</p> <p>While the sharing feature is powerful, it has some limitations:</p>
<ul> <ul>
<li><strong>Code Notes</strong>: No syntax highlighting.</li> <li data-list-item-id="e2312093b1e13d2599a9ba5032b61eb0a"><strong>Code Notes</strong>: No syntax highlighting.</li>
<li><strong>Static Note Tree</strong> <li class="ck-list-marker-bold"
data-list-item-id="e98268625774f3e965d611ae78200368c"><strong>Static Note Tree</strong>
</li> </li>
<li><strong>Protected Notes</strong>: Cannot be shared.</li> <li data-list-item-id="e9664263c42aa5c17dd020ea6bc9c2331"><strong>Protected Notes</strong>: Cannot be shared.</li>
<li><strong>Include Notes</strong>: Not supported.</li> <li data-list-item-id="e253afa5417e7d2662da0ac5c2050ab5b"><strong>Include Notes</strong>: Not supported.</li>
</ul> </ul>
<p>Some of these limitations may be addressed in future updates.</p> <p>Some of these limitations may be addressed in future updates.</p>
<h2>Prerequisites</h2> <h2>Prerequisites</h2>
<p>To use the sharing feature, you must have a&nbsp;<a class="reference-link" <p>To use the sharing feature, you must have a&nbsp;<a class="reference-link"
href="#root/_help_WOcw2SLH6tbX">Server Installation</a>&nbsp;of Trilium. href="#root/_help_WOcw2SLH6tbX">Server Installation</a>&nbsp;of Trilium.
This is necessary because the notes will be hosted from the server.</p> This is necessary because the notes will be hosted from the server.</p>
<h2>How to Share a Note</h2> <h2>Sharing a note</h2>
<ol> <ol>
<li> <li data-list-item-id="ef366c658e86436a1c6e1c41d14ba5d52">
<p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch <p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch
within the note's interface. Once sharing is enabled, an URL will appear, within the note's interface. Once sharing is enabled, an URL will appear,
which you can click to access the shared note.</p> which you can click to access the shared note.</p>
@ -188,41 +193,41 @@ class="image">
<img src="Sharing_share-single-note.png" alt="Share Note"> <img src="Sharing_share-single-note.png" alt="Share Note">
</p> </p>
</li> </li>
<li> <li data-list-item-id="ed6d52c6af04e448e70c75fcafc74e579"><strong>Access the Shared Note</strong>: The link provided will open the
<p><strong>Access the Shared Note</strong>: The link provided will open the
note in your browser. If your server is not configured with a public IP, note in your browser. If your server is not configured with a public IP,
the URL will refer to <code>localhost (127.0.0.1)</code>.</p> the URL will refer to <code>localhost (127.0.0.1)</code>.</li>
</li>
</ol> </ol>
<h2>Sharing a Note Subtree</h2> <h2>Sharing a note subtree</h2>
<p>When you share a note, you actually share the entire subtree of notes <p>When you share a note, you actually share the entire subtree of notes
beneath it. If the note has child notes, they will also be included in beneath it. If the note has child notes, they will also be included in
the shared content. For example, sharing the "Formatting" subtree will the shared content. For example, sharing the "Formatting" subtree will
display a page with basic navigation for exploring all the notes within display a page with basic navigation for exploring all the notes within
that subtree.</p> that subtree.</p>
<h2>Viewing All Shared Notes</h2> <h2>Viewing and managing shared notes</h2>
<p>You can view a list of all shared notes by clicking on "Show Shared Notes <p>You can view a list of all shared notes by clicking on "Show Shared Notes
Subtree." This allows you to manage and navigate through all the notes Subtree" in the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>.
you have made public.</p> This allows you to manage and navigate through all the notes you have made
<h2>Security Considerations</h2> public.</p>
<h2>Security considerations</h2>
<p>Shared notes are published on the open internet and can be accessed by <p>Shared notes are published on the open internet and can be accessed by
anyone with the URL. The URL's randomness does not provide security, so anyone with the URL. The URL's randomness does not provide security, so
it is crucial not to share sensitive information through this feature.</p> it is crucial not to share sensitive information through this feature.</p>
<h3>Password Protection</h3> <h3>Password protection</h3>
<p>To protect shared notes with a username and password, you can use the <code>#shareCredentials</code> attribute. <p>To protect shared notes with a username and password, you can use the <code>#shareCredentials</code> attribute.
Add this label to the note with the format <code>#shareCredentials="username:password"</code>. Add this label to the note with the format <code>#shareCredentials="username:password"</code>.
To protect an entire subtree, make sure the label is <a href="#root/_help_bwZpz2ajCEwO">inheritable</a>.</p> To protect an entire subtree, make sure the label is <a href="#root/_help_bwZpz2ajCEwO">inheritable</a>.</p>
<h2>Advanced Sharing Options</h2> <h2>Advanced sharing options</h2>
<h3>Customizing the Appearance of Shared Notes</h3> <h3>Customizing the appearance of shared notes</h3>
<p>The default design should be a good starting point, but you can customize <p>The default design should be a good starting point, but you can customize
it using your own CSS:</p> it using your own CSS:</p>
<ul> <ul>
<li><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class="reference-link" <li data-list-item-id="eafdf40b502bfe064f8b75b3e1be2e092"><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class="reference-link"
href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note to the shared page by href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note to the shared page by
adding a <code>~shareCss</code> relation to the note. If you want this style adding a <code>~shareCss</code> relation to the note. If you want this style
to apply to the entire subtree, make the label inheritable. You can hide to apply to the entire subtree, make the label inheritable. You can hide
the CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li> the CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li>
<li><strong>Omitting Default CSS</strong>: For extensive styling changes, <li
data-list-item-id="e228b06548a3174c9367e47c741c627b4"><strong>Omitting Default CSS</strong>: For extensive styling changes,
use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's
<a <a
href="#root/_help_Wy267RK4M69c">default stylesheet</a>.</li> href="#root/_help_Wy267RK4M69c">default stylesheet</a>.</li>
@ -238,35 +243,38 @@ const parentNote = await fetchNote(currentNote.parentNoteIds[0]);
for (const attr of parentNote.attributes) { for (const attr of parentNote.attributes) {
console.log(attr.type, attr.name, attr.value); console.log(attr.type, attr.name, attr.value);
}</code></pre> }</code></pre>
<h3>Creating Human-Readable URL Aliases</h3> <h3>Creating human-readable URL aliases</h3>
<p>Shared notes typically have URLs like <code>http://domain.tld/share/knvU8aJy4dJ7</code>, <p>Shared notes typically have URLs like <code>http://domain.tld/share/knvU8aJy4dJ7</code>,
where the last part is the note's ID. You can make these URLs more user-friendly where the last part is the note's ID. You can make these URLs more user-friendly
by adding the <code>#shareAlias</code> label to individual notes (e.g., <code>#shareAlias=highlighting</code>). by adding the <code>#shareAlias</code> label to individual notes (e.g., <code>#shareAlias=highlighting</code>).
This will change the URL to <code>http://domain.tld/share/highlighting</code>.</p> This will change the URL to <code>http://domain.tld/share/highlighting</code>.</p>
<p><strong>Important</strong>:</p> <p><strong>Important</strong>:</p>
<ol> <ol>
<li>Ensure that aliases are unique.</li> <li data-list-item-id="e51281f9bb5d53a9e9eb8e54b48ec8793">Ensure that aliases are unique.</li>
<li>Using slashes (<code>/</code>) within aliases to create subpaths is not <li data-list-item-id="e75aef50730416cfd9764769de2780895">Using slashes (<code>/</code>) within aliases to create subpaths is not
supported.</li> supported.</li>
</ol> </ol>
<h3>Viewing and Managing Shared Notes</h3> <h3>Setting a custom favicon</h3>
<p>All shared notes are grouped under an automatically managed "Shared Notes"
section. From here, you can view, share, or unshare notes by moving or
cloning them within this section.</p>
<p>
<img src="Sharing_shared-list.png" alt="Shared Notes List">
</p>
<h3>Setting a Custom Favicon</h3>
<p>To customize the favicon for your shared pages, create a relation <code>~shareFavicon</code> pointing <p>To customize the favicon for your shared pages, create a relation <code>~shareFavicon</code> pointing
to a file note containing the favicon (e.g., in <code>.ico</code> format).</p> to a file note containing the favicon (e.g., in <code>.ico</code> format).</p>
<h3>Sharing a Note as the Root</h3> <h3>Sharing a note as the root</h3>
<p>You can designate a specific note or folder as the root of your shared <p>You can designate a specific note or folder as the root of your shared
content by adding the <code>#shareRoot</code> label. This note will be linked content by adding the <code>#shareRoot</code> label. This note will be linked
when visiting <code>[http://domain.tld/share](http://domain/share)</code>, when visiting <code>[http://domain.tld/share](http://domain/share)</code>,
making it easier to use Trilium as a fully-fledged website. Consider combining making it easier to use Trilium as a fully-fledged website.</p>
this with the <code>#shareIndex</code> label, which will display a list of <aside class="admonition tip">
all shared notes.</p> <p>Consider combining this with the <code>#shareIndex</code> label, which will
display a list of all shared notes.</p>
</aside>
<h3>Displaying an index of shared notes</h3>
<p>When accessing a share, the sub-notes will be displayed in a tree on the
left. But since multiple note trees can be shared, it might be useful to
display a list of all the different share trees.</p>
<p>To do so, create a shared text note and apply the <code>shareIndex</code> label.
When viewed, the list of shared roots will be displayed at the bottom of
the note.</p>
<h2>Attribute reference</h2> <h2>Attribute reference</h2>
<figure class="table">
<table> <table>
<thead> <thead>
<tr> <tr>
@ -323,8 +331,8 @@ for (const attr of parentNote.attributes) {
<p>Indicates to web crawlers that the page should not be indexed of this <p>Indicates to web crawlers that the page should not be indexed of this
note by:</p> note by:</p>
<ul> <ul>
<li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li> <li data-list-item-id="e6baa9f60bf59d085fd31aa2cce07a0e7">Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li>
<li>Setting the <code>noindex, follow</code> meta tag.</li> <li data-list-item-id="ec0d067db136ef9794e4f1033405880b7">Setting the <code>noindex, follow</code> meta tag.</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@ -342,7 +350,7 @@ for (const attr of parentNote.attributes) {
</tr> </tr>
</tbody> </tbody>
</table> </table>
</figure>
<h2>Credits</h2> <h2>Credits</h2>
<p>Since v0.95.0, a new theme was introduced (and enabled by default) which <p>Since v0.95.0, a new theme was introduced (and enabled by default) which
greatly improves the visual aspect of the Share feature, as well as its greatly improves the visual aspect of the Share feature, as well as its

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png generated vendored
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 8.7 KiB

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Lists_image.png generated vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 160 B

After

Width:  |  Height:  |  Size: 8.5 KiB

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Lists_image.png generated vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.5 KiB

After

Width:  |  Height:  |  Size: 172 B

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Lists_image.png generated vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 158 B

After

Width:  |  Height:  |  Size: 147 B

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Lists_image.png generated vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.9 KiB

After

Width:  |  Height:  |  Size: 154 B

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Lists_image.png generated vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 154 B

After

Width:  |  Height:  |  Size: 158 B

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Lists_image.png generated vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 172 B

After

Width:  |  Height:  |  Size: 9.0 KiB

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Lists_image.png generated vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 147 B

After

Width:  |  Height:  |  Size: 3.9 KiB

13
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.html generated vendored
View File

@ -25,6 +25,19 @@
</ul> </ul>
</li> </li>
</ul> </ul>
<h2>Exiting out of the code block</h2>
<ul>
<li>To exit out of a code block and enter a normal paragraph, move the cursor
at the end of the code block and press <kbd>Enter</kbd> twice.</li>
<li>Similarly, to insert a paragraph above the note block, move the cursor
at the beginning of the code block and press <kbd>Enter</kbd> twice.</li>
</ul>
<aside class="admonition note">
<p>If you've pasted a code block with a more complex HTML structure, exiting
out of the code block by pressing <kbd>Enter</kbd> multiple times might not
work. In that case the best approach is to delete the code block entirely
and use <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (paste as plain text).</p>
</aside>
<h2>Syntax highlighting &amp; color schemes</h2> <h2>Syntax highlighting &amp; color schemes</h2>
<p>Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting <p>Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting
to the code block. Note that the syntax highlighting mechanism is slightly to the code block. Note that the syntax highlighting mechanism is slightly

25
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html generated vendored
View File

@ -1,15 +1,15 @@
<p>There are three types of lists supported by text notes:</p> <p>There are three types of lists supported by text notes:</p>
<ul> <ul>
<li> <li>
<img src="7_Lists_image.png" width="17" height="13">Bulleted lists (also known as unordered lists).</li> <img src="4_Lists_image.png" width="17" height="13">Bulleted lists (also known as unordered lists).</li>
<li> <li>
<img src="8_Lists_image.png" width="18" height="16">Numbered lists (or ordered lists).</li> <img src="1_Lists_image.png" width="18" height="16">Numbered lists (or ordered lists).</li>
<li> <li>
<img src="10_Lists_image.png" width="19" height="13">To-do lists</li> <img src="Lists_image.png" width="19" height="13">To-do lists</li>
</ul> </ul>
<p>For bulleted and numbered lists, it's possible to configure an alternative <p>For bulleted and numbered lists, it's possible to configure an alternative
marker such as squares or Roman numbering by pressing the marker such as squares or Roman numbering by pressing the
<img src="9_Lists_image.png" <img src="2_Lists_image.png"
width="10" height="6">icon. For numbered lists, it's also possible to specify the number to width="10" height="6">icon. For numbered lists, it's also possible to specify the number to
start at or whether to count in reverse order.</p> start at or whether to count in reverse order.</p>
<h2>Keyboard interaction</h2> <h2>Keyboard interaction</h2>
@ -20,7 +20,7 @@
by a space;</li> by a space;</li>
<li>Numbered list: Start a line with <code>1.</code> or <code>1)</code> followed <li>Numbered list: Start a line with <code>1.</code> or <code>1)</code> followed
by a space;</li> by a space;</li>
<li>To-do list: Start a line with <code>[ ]</code> for an unchecked item or <code>[x]</code> for <li>To-do list: Start a line with <code>- [ ]</code> for an unchecked item or <code>[x]</code> for
a checked item.</li> a checked item.</li>
</ul> </ul>
</li> </li>
@ -29,7 +29,7 @@
<li>To exit out of the list, press <kbd>Enter</kbd> twice.</li> <li>To exit out of the list, press <kbd>Enter</kbd> twice.</li>
<li>To merge two lists, simply delete the gap between them.</li> <li>To merge two lists, simply delete the gap between them.</li>
<li>To create nested lists, simply use the <li>To create nested lists, simply use the
<img src="2_Lists_image.png" width="17" <img src="7_Lists_image.png" width="17"
height="14">button (see <em>Indentation</em> in&nbsp;<a class="reference-link" href="#root/_help_dEHYtoWWi8ct">Other features</a>) height="14">button (see <em>Indentation</em> in&nbsp;<a class="reference-link" href="#root/_help_dEHYtoWWi8ct">Other features</a>)
or the <kbd>Tab</kbd> key. To decrease the nesting level for the current or the <kbd>Tab</kbd> key. To decrease the nesting level for the current
element, press <kbd>Shift</kbd>+<kbd>Tab</kbd>.</li> element, press <kbd>Shift</kbd>+<kbd>Tab</kbd>.</li>
@ -56,7 +56,7 @@
<tr> <tr>
<td>2</td> <td>2</td>
<td> <td>
<img src="4_Lists_image.png"> <img src="9_Lists_image.png">
</td> </td>
<td>Press Enter to create a new list item.</td> <td>Press Enter to create a new list item.</td>
</tr> </tr>
@ -71,7 +71,7 @@
<td>4</td> <td>4</td>
<td> <td>
<img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" <img class="image_resized" style="aspect-ratio:676/112;width:98.29%;"
src="1_Lists_image.png" width="676" height="112"> src="10_Lists_image.png" width="676" height="112">
</td> </td>
<td>At this point, insert any desired block-level item such as a code block.</td> <td>At this point, insert any desired block-level item such as a code block.</td>
</tr> </tr>
@ -79,7 +79,7 @@
<td>5</td> <td>5</td>
<td> <td>
<img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" <img class="image_resized" style="aspect-ratio:675/129;width:94.22%;"
src="Lists_image.png" width="675" height="129"> src="8_Lists_image.png" width="675" height="129">
</td> </td>
<td>To continue with a new bullet point, press Enter until the cursor moves <td>To continue with a new bullet point, press Enter until the cursor moves
to a new blank position.</td> to a new blank position.</td>
@ -96,3 +96,10 @@
</table> </table>
<p>The same principle applies to all three list types (bullet, numbered and <p>The same principle applies to all three list types (bullet, numbered and
to-do).</p> to-do).</p>
<h2>To-do lists</h2>
<ul>
<li>To insert a to-do list from the keyboard, type <code>- [ ]</code> for an
unchecked item or <code>[x]</code> for a checked item while on an empty paragraph.</li>
<li>To reorder the item under the cursor, press <kbd>Alt</kbd>+<kbd>Up</kbd> or <kbd>Alt</kbd>+<kbd>Down</kbd>.
To reorder multiple items, select them first.</li>
</ul>

BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png generated vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.0 KiB

After

Width:  |  Height:  |  Size: 160 B

2
docs/Developer Guide/!!!meta.json vendored
View File

@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.98.1", "appVersion": "0.99.0",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,

2
docs/Release Notes/!!!meta.json vendored
View File

@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.98.1", "appVersion": "0.99.0",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,

64
docs/User Guide/!!!meta.json vendored
View File

@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.98.1", "appVersion": "0.99.0",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,
@ -6713,23 +6713,23 @@
"dataFileName": "Lists.md", "dataFileName": "Lists.md",
"attachments": [ "attachments": [
{ {
"attachmentId": "5cmICTYfg13g", "attachmentId": "1d3z8mz0JANE",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/jpg", "mime": "image/png",
"position": 10, "position": 10,
"dataFileName": "Lists_image.png" "dataFileName": "Lists_image.png"
}, },
{ {
"attachmentId": "6jl7tboJfutt", "attachmentId": "7YtO7boIQcSu",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/jpg", "mime": "image/png",
"position": 10, "position": 10,
"dataFileName": "1_Lists_image.png" "dataFileName": "1_Lists_image.png"
}, },
{ {
"attachmentId": "7Ledf67P1S1b", "attachmentId": "eCftcYsVKdAI",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/png", "mime": "image/png",
@ -6737,7 +6737,7 @@
"dataFileName": "2_Lists_image.png" "dataFileName": "2_Lists_image.png"
}, },
{ {
"attachmentId": "d4XfLoK5srYZ", "attachmentId": "fB3ZhdfysYC3",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/jpg", "mime": "image/jpg",
@ -6745,15 +6745,15 @@
"dataFileName": "3_Lists_image.png" "dataFileName": "3_Lists_image.png"
}, },
{ {
"attachmentId": "eL11eZMPwpmH", "attachmentId": "IZewdPx4evIx",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/jpg", "mime": "image/png",
"position": 10, "position": 10,
"dataFileName": "4_Lists_image.png" "dataFileName": "4_Lists_image.png"
}, },
{ {
"attachmentId": "EnkTpdeLJ6Ft", "attachmentId": "JopMc0iA0dqA",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/jpg", "mime": "image/jpg",
@ -6761,7 +6761,7 @@
"dataFileName": "5_Lists_image.png" "dataFileName": "5_Lists_image.png"
}, },
{ {
"attachmentId": "If3k6Tt5cPBt", "attachmentId": "kZMYrJubac6T",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/jpg", "mime": "image/jpg",
@ -6769,7 +6769,7 @@
"dataFileName": "6_Lists_image.png" "dataFileName": "6_Lists_image.png"
}, },
{ {
"attachmentId": "MxgVFEyXwRxo", "attachmentId": "PGeVq8YAQBFA",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/png", "mime": "image/png",
@ -6777,26 +6777,26 @@
"dataFileName": "7_Lists_image.png" "dataFileName": "7_Lists_image.png"
}, },
{ {
"attachmentId": "Te4LNZWv4ovM", "attachmentId": "VgoG6BtlLYn7",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/png", "mime": "image/jpg",
"position": 10, "position": 10,
"dataFileName": "8_Lists_image.png" "dataFileName": "8_Lists_image.png"
}, },
{ {
"attachmentId": "tqeIwudL5QEY", "attachmentId": "y0zFP6x0IRRf",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/png", "mime": "image/jpg",
"position": 10, "position": 10,
"dataFileName": "9_Lists_image.png" "dataFileName": "9_Lists_image.png"
}, },
{ {
"attachmentId": "zZGT8pbt2myS", "attachmentId": "z8eVlXe2WKqr",
"title": "image.png", "title": "image.png",
"role": "image", "role": "image",
"mime": "image/png", "mime": "image/jpg",
"position": 10, "position": 10,
"dataFileName": "10_Lists_image.png" "dataFileName": "10_Lists_image.png"
} }
@ -10451,24 +10451,31 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "bwZpz2ajCEwO", "value": "x3i7MxGccDuM",
"isInheritable": false, "isInheritable": false,
"position": 150 "position": 150
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "Wy267RK4M69c", "value": "bwZpz2ajCEwO",
"isInheritable": false, "isInheritable": false,
"position": 160 "position": 160
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "Qjt68inQ2bRj", "value": "Wy267RK4M69c",
"isInheritable": false, "isInheritable": false,
"position": 170 "position": 170
}, },
{
"type": "relation",
"name": "internalLink",
"value": "Qjt68inQ2bRj",
"isInheritable": false,
"position": 180
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -10487,14 +10494,6 @@
"format": "markdown", "format": "markdown",
"dataFileName": "Sharing.md", "dataFileName": "Sharing.md",
"attachments": [ "attachments": [
{
"attachmentId": "2kLFcH6hel9i",
"title": "shared-list.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Sharing_shared-list.png"
},
{ {
"attachmentId": "ibqWQUOCMhIE", "attachmentId": "ibqWQUOCMhIE",
"title": "image.png", "title": "image.png",
@ -11385,6 +11384,13 @@
"type": "text", "type": "text",
"mime": "text/markdown", "mime": "text/markdown",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "tAassRL4RSQL",
"isInheritable": false,
"position": 10
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",

4
docs/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md vendored
View File

@ -1,6 +1,10 @@
# Configuration (config.ini or environment variables) # Configuration (config.ini or environment variables)
Trilium supports configuration via a file named `config.ini` and environment variables. This document provides a comprehensive reference for all configuration options. Trilium supports configuration via a file named `config.ini` and environment variables. This document provides a comprehensive reference for all configuration options.
## Location of the configuration file
The configuration file is not located in the same directory as the application. Instead, the `config.ini` is located in the <a class="reference-link" href="../Installation%20%26%20Setup/Data%20directory.md">Data directory</a>. As such, the configuration file is only available after starting the application and creating a database.
## Configuration Precedence ## Configuration Precedence
Configuration values are loaded in the following order of precedence (highest to lowest): Configuration values are loaded in the following order of precedence (highest to lowest):

43
docs/User Guide/User Guide/Advanced Usage/Sharing.md vendored
View File

@ -16,7 +16,7 @@ Trilium allows you to share selected notes as **publicly accessible** read-only
### By note type ### By note type
<table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th>&nbsp;</th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li>Table of contents.</li><li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li>Rendering for math equations.</li></ul></td><td><ul><li>Including notes is not supported.</li><li>Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li>No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Collections.md">Collections</a></th><td><ul><li>The child notes are displayed in a fixed format.&nbsp;</li></ul></td><td><ul><li>More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Collections/Geo%20Map%20View.md">Geo Map View</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table> <table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th>&nbsp;</th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li data-list-item-id="e26b4ce9ba4e9dfe224d04e0f341925ed">Table of contents.</li><li data-list-item-id="e9707fdfa2c92d66690cf932f7e647253">Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li data-list-item-id="e84420a10c6d64bd107edb6e867c91d4b">Rendering for math equations.</li></ul></td><td><ul><li data-list-item-id="ecbc365d4886911af8859ccd0e1bbc465">Including notes is not supported.</li><li data-list-item-id="e41cc4139377f9f88d653d1eb8ca47bb4">Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li data-list-item-id="e291ae6d5130677b4c99f7c3bdbe974b4">Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li data-list-item-id="e0270680bbdd7a129306e61e11691e36d">No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Collections.md">Collections</a></th><td><ul><li data-list-item-id="ea031e1d4149eb443ace756234490c5a4">The child notes are displayed in a fixed format.&nbsp;</li></ul></td><td><ul><li data-list-item-id="ea4a9d424aec2afbaecc07bbf64b7bebd">More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li data-list-item-id="e582d283f2b1b30cbe5ae35d8e01b2bf2">The diagram is displayed as a vector image.</li></ul></td><td><ul><li data-list-item-id="e33268686446e3c217077201bb5964364">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li data-list-item-id="e443dd0e97c30cb12c77e8906a71569ea">The diagram is displayed as a vector image.</li></ul></td><td><ul><li data-list-item-id="efe151ef3f3826c825416417525fb5fb2">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li data-list-item-id="ed3b4fb473042f6e32b4502d4fa11a767">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Collections/Geo%20Map%20View.md">Geo Map View</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li data-list-item-id="ed87e836a39d127ebcbb33e9e59045afb">No further interaction supported.</li></ul></td></tr></tbody></table>
While the sharing feature is powerful, it has some limitations: While the sharing feature is powerful, it has some limitations:
@ -31,32 +31,32 @@ Some of these limitations may be addressed in future updates.
To use the sharing feature, you must have a <a class="reference-link" href="../Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a> of Trilium. This is necessary because the notes will be hosted from the server. To use the sharing feature, you must have a <a class="reference-link" href="../Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a> of Trilium. This is necessary because the notes will be hosted from the server.
## How to Share a Note ## Sharing a note
1. **Enable Sharing**: To share a note, toggle the `Shared` switch within the note's interface. Once sharing is enabled, an URL will appear, which you can click to access the shared note. 1. **Enable Sharing**: To share a note, toggle the `Shared` switch within the note's interface. Once sharing is enabled, an URL will appear, which you can click to access the shared note.
![Share Note](Sharing_share-single-note.png) ![Share Note](Sharing_share-single-note.png)
2. **Access the Shared Note**: The link provided will open the note in your browser. If your server is not configured with a public IP, the URL will refer to `localhost (127.0.0.1)`. 2. **Access the Shared Note**: The link provided will open the note in your browser. If your server is not configured with a public IP, the URL will refer to `localhost (127.0.0.1)`.
## Sharing a Note Subtree ## Sharing a note subtree
When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the "Formatting" subtree will display a page with basic navigation for exploring all the notes within that subtree. When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the "Formatting" subtree will display a page with basic navigation for exploring all the notes within that subtree.
## Viewing All Shared Notes ## Viewing and managing shared notes
You can view a list of all shared notes by clicking on "Show Shared Notes Subtree." This allows you to manage and navigate through all the notes you have made public. You can view a list of all shared notes by clicking on "Show Shared Notes Subtree" in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a>. This allows you to manage and navigate through all the notes you have made public.
## Security Considerations ## Security considerations
Shared notes are published on the open internet and can be accessed by anyone with the URL. The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature. Shared notes are published on the open internet and can be accessed by anyone with the URL. The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.
### Password Protection ### Password protection
To protect shared notes with a username and password, you can use the `#shareCredentials` attribute. Add this label to the note with the format `#shareCredentials="username:password"`. To protect an entire subtree, make sure the label is [inheritable](Attributes/Attribute%20Inheritance.md). To protect shared notes with a username and password, you can use the `#shareCredentials` attribute. Add this label to the note with the format `#shareCredentials="username:password"`. To protect an entire subtree, make sure the label is [inheritable](Attributes/Attribute%20Inheritance.md).
## Advanced Sharing Options ## Advanced sharing options
### Customizing the Appearance of Shared Notes ### Customizing the appearance of shared notes
The default design should be a good starting point, but you can customize it using your own CSS: The default design should be a good starting point, but you can customize it using your own CSS:
@ -78,7 +78,7 @@ for (const attr of parentNote.attributes) {
} }
``` ```
### Creating Human-Readable URL Aliases ### Creating human-readable URL aliases
Shared notes typically have URLs like `http://domain.tld/share/knvU8aJy4dJ7`, where the last part is the note's ID. You can make these URLs more user-friendly by adding the `#shareAlias` label to individual notes (e.g., `#shareAlias=highlighting`). This will change the URL to `http://domain.tld/share/highlighting`. Shared notes typically have URLs like `http://domain.tld/share/knvU8aJy4dJ7`, where the last part is the note's ID. You can make these URLs more user-friendly by adding the `#shareAlias` label to individual notes (e.g., `#shareAlias=highlighting`). This will change the URL to `http://domain.tld/share/highlighting`.
@ -87,23 +87,26 @@ Shared notes typically have URLs like `http://domain.tld/share/knvU8aJy4dJ7`, wh
1. Ensure that aliases are unique. 1. Ensure that aliases are unique.
2. Using slashes (`/`) within aliases to create subpaths is not supported. 2. Using slashes (`/`) within aliases to create subpaths is not supported.
### Viewing and Managing Shared Notes ### Setting a custom favicon
All shared notes are grouped under an automatically managed "Shared Notes" section. From here, you can view, share, or unshare notes by moving or cloning them within this section.
![Shared Notes List](Sharing_shared-list.png)
### Setting a Custom Favicon
To customize the favicon for your shared pages, create a relation `~shareFavicon` pointing to a file note containing the favicon (e.g., in `.ico` format). To customize the favicon for your shared pages, create a relation `~shareFavicon` pointing to a file note containing the favicon (e.g., in `.ico` format).
### Sharing a Note as the Root ### Sharing a note as the root
You can designate a specific note or folder as the root of your shared content by adding the `#shareRoot` label. This note will be linked when visiting `[http://domain.tld/share](http://domain/share)`, making it easier to use Trilium as a fully-fledged website. Consider combining this with the `#shareIndex` label, which will display a list of all shared notes. You can designate a specific note or folder as the root of your shared content by adding the `#shareRoot` label. This note will be linked when visiting `[http://domain.tld/share](http://domain/share)`, making it easier to use Trilium as a fully-fledged website.
> [!TIP]
> Consider combining this with the `#shareIndex` label, which will display a list of all shared notes.
### Displaying an index of shared notes
When accessing a share, the sub-notes will be displayed in a tree on the left. But since multiple note trees can be shared, it might be useful to display a list of all the different share trees.
To do so, create a shared text note and apply the `shareIndex` label. When viewed, the list of shared roots will be displayed at the bottom of the note.
## Attribute reference ## Attribute reference
<table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>shareHiddenFromTree</code></td><td>this note is hidden from left navigation tree, but still accessible with its URL</td></tr><tr><td><code>shareExternalLink</code></td><td>note will act as a link to an external website in the share tree</td></tr><tr><td><code>shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>shareDescription</code></td><td>define text to be added to the HTML meta tag for description</td></tr><tr><td><code>shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;<a class="reference-link" href="Sharing/Serving%20directly%20the%20content%20o.md">Serving directly the content of a note</a>&nbsp;for an alternative method without setting an attribute.</td></tr><tr><td><code>shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li>Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr></tbody></table> <table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>shareHiddenFromTree</code></td><td>this note is hidden from left navigation tree, but still accessible with its URL</td></tr><tr><td><code>shareExternalLink</code></td><td>note will act as a link to an external website in the share tree</td></tr><tr><td><code>shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>shareDescription</code></td><td>define text to be added to the HTML meta tag for description</td></tr><tr><td><code>shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;<a class="reference-link" href="Sharing/Serving%20directly%20the%20content%20o.md">Serving directly the content of a note</a>&nbsp;for an alternative method without setting an attribute.</td></tr><tr><td><code>shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li data-list-item-id="e6baa9f60bf59d085fd31aa2cce07a0e7">Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li data-list-item-id="ec0d067db136ef9794e4f1033405880b7">Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr></tbody></table>
## Credits ## Credits

BIN
docs/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png vendored
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 8.7 KiB

BIN
docs/User Guide/User Guide/Note Types/Text/10_Lists_image.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 160 B

After

Width:  |  Height:  |  Size: 8.5 KiB

BIN
docs/User Guide/User Guide/Note Types/Text/1_Lists_image.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.5 KiB

After

Width:  |  Height:  |  Size: 172 B

BIN
docs/User Guide/User Guide/Note Types/Text/2_Lists_image.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 158 B

After

Width:  |  Height:  |  Size: 147 B

BIN
docs/User Guide/User Guide/Note Types/Text/4_Lists_image.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.9 KiB

After

Width:  |  Height:  |  Size: 154 B

BIN
docs/User Guide/User Guide/Note Types/Text/7_Lists_image.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 154 B

After

Width:  |  Height:  |  Size: 158 B

BIN
docs/User Guide/User Guide/Note Types/Text/8_Lists_image.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 172 B

After

Width:  |  Height:  |  Size: 9.0 KiB

BIN
docs/User Guide/User Guide/Note Types/Text/9_Lists_image.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 147 B

After

Width:  |  Height:  |  Size: 3.9 KiB

8
docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.md vendored
View File

@ -13,6 +13,14 @@ Note that this feature is meant for generally small snippets of code. For larger
* Type ` ``` ` (as in Markdown). * Type ` ``` ` (as in Markdown).
* Note that it's not possible to specify the language, as it will default to the last selected language. * Note that it's not possible to specify the language, as it will default to the last selected language.
## Exiting out of the code block
* To exit out of a code block and enter a normal paragraph, move the cursor at the end of the code block and press <kbd>Enter</kbd> twice.
* Similarly, to insert a paragraph above the note block, move the cursor at the beginning of the code block and press <kbd>Enter</kbd> twice.
> [!NOTE]
> If you've pasted a code block with a more complex HTML structure, exiting out of the code block by pressing <kbd>Enter</kbd> multiple times might not work. In that case the best approach is to delete the code block entirely and use <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (paste as plain text).
## Syntax highlighting & color schemes ## Syntax highlighting & color schemes
Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting to the code block. Note that the syntax highlighting mechanism is slightly different than the one in <a class="reference-link" href="../../Code.md">Code</a> notes as different technologies are involved. Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting to the code block. Note that the syntax highlighting mechanism is slightly different than the one in <a class="reference-link" href="../../Code.md">Code</a> notes as different technologies are involved.

23
docs/User Guide/User Guide/Note Types/Text/Lists.md vendored
View File

@ -1,23 +1,23 @@
# Lists # Lists
There are three types of lists supported by text notes: There are three types of lists supported by text notes:
* <img src="7_Lists_image.png" width="17" height="13"> Bulleted lists (also known as unordered lists). * <img src="4_Lists_image.png" width="17" height="13"> Bulleted lists (also known as unordered lists).
* <img src="8_Lists_image.png" width="18" height="16"> Numbered lists (or ordered lists). * <img src="1_Lists_image.png" width="18" height="16"> Numbered lists (or ordered lists).
* <img src="10_Lists_image.png" width="19" height="13"> To-do lists * <img src="Lists_image.png" width="19" height="13"> To-do lists
For bulleted and numbered lists, it's possible to configure an alternative marker such as squares or Roman numbering by pressing the <img src="9_Lists_image.png" width="10" height="6"> icon. For numbered lists, it's also possible to specify the number to start at or whether to count in reverse order. For bulleted and numbered lists, it's possible to configure an alternative marker such as squares or Roman numbering by pressing the <img src="2_Lists_image.png" width="10" height="6"> icon. For numbered lists, it's also possible to specify the number to start at or whether to count in reverse order.
## Keyboard interaction ## Keyboard interaction
* To create a new list: * To create a new list:
* Bulleted list: Start a line with `*` or `-` followed by a space; * Bulleted list: Start a line with `*` or `-` followed by a space;
* Numbered list: Start a line with `1.` or `1)` followed by a space; * Numbered list: Start a line with `1.` or `1)` followed by a space;
* To-do list: Start a line with `[ ]` for an unchecked item or `[x]` for a checked item. * To-do list: Start a line with `- [ ]` for an unchecked item or `[x]` for a checked item.
* To create a new item in the list, press <kbd>Enter</kbd>. * To create a new item in the list, press <kbd>Enter</kbd>.
* To create a blank line within a list item, press <kbd>Shift</kbd>+<kbd>Enter</kbd>. * To create a blank line within a list item, press <kbd>Shift</kbd>+<kbd>Enter</kbd>.
* To exit out of the list, press <kbd>Enter</kbd> twice. * To exit out of the list, press <kbd>Enter</kbd> twice.
* To merge two lists, simply delete the gap between them. * To merge two lists, simply delete the gap between them.
* To create nested lists, simply use the <img src="2_Lists_image.png" width="17" height="14"> button (see _Indentation_ in <a class="reference-link" href="Other%20features.md">Other features</a>) or the <kbd>Tab</kbd> key. To decrease the nesting level for the current element, press <kbd>Shift</kbd>+<kbd>Tab</kbd>. * To create nested lists, simply use the <img src="7_Lists_image.png" width="17" height="14"> button (see _Indentation_ in <a class="reference-link" href="Other%20features.md">Other features</a>) or the <kbd>Tab</kbd> key. To decrease the nesting level for the current element, press <kbd>Shift</kbd>+<kbd>Tab</kbd>.
## Headings, code blocks within lists ## Headings, code blocks within lists
@ -26,10 +26,15 @@ It possible to add content-level blocks such as headings, code blocks, tables wi
| | | | | | | |
| --- | --- | --- | | --- | --- | --- |
| 1 | ![](6_Lists_image.png) | First, create a list. | | 1 | ![](6_Lists_image.png) | First, create a list. |
| 2 | ![](4_Lists_image.png) | Press Enter to create a new list item. | | 2 | ![](9_Lists_image.png) | Press Enter to create a new list item. |
| 3 | ![](5_Lists_image.png) | Press Backspace to get rid of the bullet point. Notice the cursor position. | | 3 | ![](5_Lists_image.png) | Press Backspace to get rid of the bullet point. Notice the cursor position. |
| 4 | <img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" src="1_Lists_image.png" width="676" height="112"> | At this point, insert any desired block-level item such as a code block. | | 4 | <img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" src="10_Lists_image.png" width="676" height="112"> | At this point, insert any desired block-level item such as a code block. |
| 5 | <img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" src="Lists_image.png" width="675" height="129"> | To continue with a new bullet point, press Enter until the cursor moves to a new blank position. | | 5 | <img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" src="8_Lists_image.png" width="675" height="129"> | To continue with a new bullet point, press Enter until the cursor moves to a new blank position. |
| 6 | <img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="3_Lists_image.png" width="675" height="129"> | Press Enter once more to create the new bullet. | | 6 | <img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="3_Lists_image.png" width="675" height="129"> | Press Enter once more to create the new bullet. |
The same principle applies to all three list types (bullet, numbered and to-do). The same principle applies to all three list types (bullet, numbered and to-do).
## To-do lists
* To insert a to-do list from the keyboard, type `- [ ]` for an unchecked item or `[x]` for a checked item while on an empty paragraph.
* To reorder the item under the cursor, press <kbd>Alt</kbd>+<kbd>Up</kbd> or <kbd>Alt</kbd>+<kbd>Down</kbd>. To reorder multiple items, select them first.

BIN
docs/User Guide/User Guide/Note Types/Text/Lists_image.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.0 KiB

After

Width:  |  Height:  |  Size: 160 B