Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-03 20:06:08 +01:00
Code Issues Packages Projects Releases Activity

docs(guide): document included notes in share

Browse Source
This commit is contained in:
Elian Doran
2025-10-01 19:33:11 +03:00
parent 29fa335a27
commit ae0bb78b1c
5 changed files with 50 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -8,17 +8,17 @@ class="image">
</figure>
<h2>Features, interaction and limitations</h2>
<ul>
<li data-list-item-id="e865d86fdfe94260d08e3631d5b36047f">Searching by note title.</li>
<li data-list-item-id="e13b5deb15035a950c34a64d66ca76459">Automatic dark/light mode based on the user's browser settings.</li>
<li data-list-item-id="eb3d8067f5cb94bac4a4a84183ef4ed02">Searching by note title.</li>
<li data-list-item-id="ed2b6bee8436ae78524bb348bab92b590">Automatic dark/light mode based on the user's browser settings.</li>
<li
data-list-item-id="eae144f08e29157dad576c0011d14f99d">Mobile-friendly layout, with sidebar.</li>
<li data-list-item-id="e25712924a5a1322c8b903f832475bf0a">Collapsible tree with the same note icons as the application.</li>
data-list-item-id="e3d6e72b17bee26edd1cdf32f6622d1a8">Mobile-friendly layout, with sidebar.</li>
<li data-list-item-id="e82d45b6ad8b782bf44e765283f7648af">Collapsible tree with the same note icons as the application.</li>
<li
data-list-item-id="ed9e131634923af3f9811002b4efb6f83">Customizable logo.</li>
<li data-list-item-id="ef52ad44bbd9f39ac8884848c8ac94c02">Toggle button for dark/light mode, which also stores the user preferences.</li>
data-list-item-id="e9672befb64e973ce887f2a993f426f22">Customizable logo.</li>
<li data-list-item-id="e4aa50a784c9b83cdbe894eac6c4512e9">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>
data-list-item-id="e0ba76ae1a1b97e38ca239ccc919ad562">Quick navigation buttons (previous and next note).</li>
<li data-list-item-id="e2a6c8a3de7eedaf5b344f136e298fd49">Displaying the date of the last update of the note.</li>
</ul>
<h3>By note type</h3>
<figure class="table">
@@ -45,11 +45,12 @@ class="image">
<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>
<li data-list-item-id="e10834dcd0619d77ae2e94d3695bedf58"><a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_nBAXQFj20hS1">Including notes</a> (only
if the included notes are also shared).</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>
@@ -171,12 +172,12 @@ class="image">
</figure>
<p>While the sharing feature is powerful, it has some limitations:</p>
<ul>
<li data-list-item-id="e2312093b1e13d2599a9ba5032b61eb0a"><strong>Code Notes</strong>: No syntax highlighting.</li>
<li data-list-item-id="e4d030291f0f3baf41b533c9aab0958fa"><strong>Code Notes</strong>: No syntax highlighting.</li>
<li class="ck-list-marker-bold"
data-list-item-id="e98268625774f3e965d611ae78200368c"><strong>Static Note Tree</strong>
data-list-item-id="ec84705de13a1a2ce9f21bc5fd8b3ad64"><strong>Static Note Tree</strong>
</li>
<li data-list-item-id="e9664263c42aa5c17dd020ea6bc9c2331"><strong>Protected Notes</strong>: Cannot be shared.</li>
<li data-list-item-id="e253afa5417e7d2662da0ac5c2050ab5b"><strong>Include Notes</strong>: Not supported.</li>
<li data-list-item-id="e5391374edc6fa023765af8802dae2d75"><strong>Protected Notes</strong>: Cannot be shared.</li>
<li data-list-item-id="e6556bb11a4c4bf2f4d44519a8c055634"><strong>Include Notes</strong>: Not supported.</li>
</ul>
<p>Some of these limitations may be addressed in future updates.</p>
<h2>Prerequisites</h2>
@@ -185,7 +186,7 @@ class="image">
This is necessary because the notes will be hosted from the server.</p>
<h2>Sharing a note</h2>
<ol>
<li data-list-item-id="ef366c658e86436a1c6e1c41d14ba5d52">
<li data-list-item-id="eb0acda67602064cf3393dd478527d708">
<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,
which you can click to access the shared note.</p>
@@ -193,7 +194,7 @@ class="image">
<img src="Sharing_share-single-note.png" alt="Share Note">
</p>
</li>
<li data-list-item-id="ed6d52c6af04e448e70c75fcafc74e579"><strong>Access the Shared Note</strong>: The link provided will open the
<li data-list-item-id="e295548918d29695504a2356e807593e5"><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,
the URL will refer to <code>localhost (127.0.0.1)</code>.</li>
</ol>
@@ -221,13 +222,13 @@ class="image">
<p>The default design should be a good starting point, but you can customize
it using your own CSS:</p>
<ul>
<li data-list-item-id="eafdf40b502bfe064f8b75b3e1be2e092"><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class="reference-link"
<li data-list-item-id="e86cb1bab4a5f642720bad026d50f7742"><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
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
the CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li>
<li
data-list-item-id="e228b06548a3174c9367e47c741c627b4"><strong>Omitting Default CSS</strong>: For extensive styling changes,
data-list-item-id="ec911775f2f39d62f7a6a2ab762e3f773"><strong>Omitting Default CSS</strong>: For extensive styling changes,
use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's
<a
href="#root/_help_Wy267RK4M69c">default stylesheet</a>.</li>
@@ -250,8 +251,8 @@ for (const attr of parentNote.attributes) {
This will change the URL to <code>http://domain.tld/share/highlighting</code>.</p>
<p><strong>Important</strong>:</p>
<ol>
<li data-list-item-id="e51281f9bb5d53a9e9eb8e54b48ec8793">Ensure that aliases are unique.</li>
<li data-list-item-id="e75aef50730416cfd9764769de2780895">Using slashes (<code>/</code>) within aliases to create subpaths is not
<li data-list-item-id="e15a33a78ef6f36ad0aa99341387051b0">Ensure that aliases are unique.</li>
<li data-list-item-id="ed1ec56ed4f152f9adceacf6053ecaac2">Using slashes (<code>/</code>) within aliases to create subpaths is not
supported.</li>
</ol>
<h3>Setting a custom favicon</h3>

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

@@ -5,4 +5,11 @@
<p>In the&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>,
look for the
<img src="Include Note_image.png">button. There is also a keyboard shortcut defined for it but it is not
allocated by default.</p>
allocated by default.</p>
<h2>Included notes in the share functionality</h2>
<p>If a <a href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_R9pX4DGra2Vt">shared note</a> contains
one or more included notes, they will be displayed in the content of the
note as if they were part of the note itself.</p>
<p>For this to work, the included notes must also be shared, otherwise they
will not be shown. However, the included notes can still be hidden from
the note tree via <code>#shareHiddenFromTree</code>.</p>