Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-09 14:55:50 +01:00
Code Issues Packages Projects Releases Activity

docs: sync

Browse Source
This commit is contained in:
Elian Doran
2025-11-05 21:01:39 +02:00
parent 2e14522f86
commit ba61ab18ff
5 changed files with 33 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because one or more lines are too long

36
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Exporting static HTML for web .html generated vendored
View File

@@ -24,33 +24,31 @@
<p>Apart from normal&nbsp;<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>, <p>Apart from normal&nbsp;<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>,
exporting to static HTML files comes with a few subtle differences:</p> exporting to static HTML files comes with a few subtle differences:</p>
<ul> <ul>
<li data-list-item-id="e757e614020a02864a52b3b8f9f2b792f">The URL structure is different. Where in normal sharing it's something <li>The URL structure is different. Where in normal sharing it's something
along the way of <code>example.com/share/noteid</code>, the notes follow along the way of <code>example.com/share/noteid</code>, the notes follow
an hierarchical structure, such as <code>docs.triliumnotes.org/user-guide/concepts/navigation/tree-concepts</code>.</li> an hierarchical structure, such as <code>docs.triliumnotes.org/user-guide/concepts/navigation/tree-concepts</code>.</li>
<li <li>The <code>favicon.ico</code> is not handled automatically, it needs to be
data-list-item-id="e04429f1cf40760df3c0cd932d1107bfd">The <code>favicon.ico</code> is not handled automatically, it needs to be
manually added on the server after the export is generated.</li> manually added on the server after the export is generated.</li>
<li data-list-item-id="e5d86e8060c41292df46d0adcfffd5113">The “Last updated” for notes is not available.</li> <li>The “Last updated” for notes is not available.</li>
<li data-list-item-id="eb09fc171d1adcf6923bef3aaebb316d0">The search functionality works slightly different since the normal one <li>The search functionality works slightly different since the normal one
requires an active API to work. In the static export, search still works requires an active API to work. In the static export, search still works
but uses a different mechanism so results might be different.</li> but uses a different mechanism so results might be different.</li>
</ul> </ul>
<h2>Differences from normal .zip export</h2> <h2>Differences from normal .zip export</h2>
<ul> <ul>
<li data-list-item-id="e105d2557437171cb7ce15f84fe7bc405">The name of the files/URLs will prefer <code>shareAlias</code> to allow <li>The name of the files/URLs will prefer <code>shareAlias</code> to allow
for clean URLs.</li> for clean URLs.</li>
<li data-list-item-id="ed984cadd9496205a76341b206776d5c7">The export requires a functional web server as the pages will not render <li>The export requires a functional web server as the pages will not render
properly if accessed locally via a web browser due to the use of module properly if accessed locally via a web browser due to the use of module
scripts.</li> scripts.</li>
<li data-list-item-id="ed0a279aec254358dcff1769e08fc548b">The directory structure is also slightly different: <li>The directory structure is also slightly different:
<ul> <ul>
<li data-list-item-id="ed8b6890f4850eaa869269cb03b812924">A normal HTML export results in an index file and a single directory.</li> <li>A normal HTML export results in an index file and a single directory.</li>
<li <li>Instead, for static exporting the top-root level becomes the index file
data-list-item-id="e94e121f725d76c6bb10596f72bb44fd3">Instead, for static exporting the top-root level becomes the index file
and the child directories are on the root instead.</li> and the child directories are on the root instead.</li>
<li data-list-item-id="eee85ca77bfc3f3f78042272fbe072610">This makes it possible to easily publish to a website, without forcing <li>This makes it possible to easily publish to a website, without forcing
everything but the root note to be in a sub-directory.</li> everything but the root note to be in a sub-directory.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
<h2>Testing locally</h2> <h2>Testing locally</h2>
@@ -60,9 +58,9 @@
can be installed via:</p><pre><code class="language-text-x-trilium-auto">npm i -g http-server</code></pre> can be installed via:</p><pre><code class="language-text-x-trilium-auto">npm i -g http-server</code></pre>
<p>Once installed simply:</p> <p>Once installed simply:</p>
<ol> <ol>
<li data-list-item-id="ef3a455a98e83613ee8cb2fdd55327951">Extract the exported .zip file.</li> <li>Extract the exported .zip file.</li>
<li data-list-item-id="e0a88b24efdc8f247105086ada68cf617">Inside the extracted directory, run <code>http-server</code>.</li> <li>Inside the extracted directory, run <code>http-server</code>.</li>
<li data-list-item-id="e533233e9ad5f4a52cddb6e141f26b444">Access the indicated address (e.g. <a href="http://localhost:8080">http://localhost:8080</a>).</li> <li>Access the indicated address (e.g. <a href="http://localhost:8080">http://localhost:8080</a>).</li>
</ol> </ol>
<h2>Automation</h2> <h2>Automation</h2>
<p><a class="reference-link" href="#root/_help_pgxEVkzLl1OP">ETAPI (REST API)</a>&nbsp;could <p><a class="reference-link" href="#root/_help_pgxEVkzLl1OP">ETAPI (REST API)</a>&nbsp;could

15
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Widget Basics.html generated vendored
View File

@@ -16,11 +16,11 @@
module.exports = new MyWidget();</code></pre> module.exports = new MyWidget();</code></pre>
<p>To implement this widget:</p> <p>To implement this widget:</p>
<ol> <ol>
<li data-list-item-id="ed70b15c6cddbf0d0ac049dccd6835c5b">Create a new <code>JS Frontend</code> note in Trilium and paste in the code <li>Create a new <code>JS Frontend</code> note in Trilium and paste in the code
above.</li> above.</li>
<li data-list-item-id="e507afc0bb1d604a590eba80b6137d84b">Assign the <code>#widget</code> <a href="#root/_help_zEY4DaJG4YT5">attribute</a> to <li>Assign the <code>#widget</code> <a href="#root/_help_zEY4DaJG4YT5">attribute</a> to
the <a href="#root/_help_BFs8mudNFgCS">note</a>.</li> the <a href="#root/_help_BFs8mudNFgCS">note</a>.</li>
<li data-list-item-id="e876a226740e2dcfb2a900ebd674b2b6b">Restart Trilium or reload the window.</li> <li>Restart Trilium or reload the window.</li>
</ol> </ol>
<p>To verify that the widget is working, open the developer tools (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>I</kbd>) <p>To verify that the widget is working, open the developer tools (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>I</kbd>)
and run <code>document.querySelector("#my-widget")</code>. If the element and run <code>document.querySelector("#my-widget")</code>. If the element
@@ -89,14 +89,13 @@ module.exports = new MyWidget();</code></pre>
module.exports = new MyWidget();</code></pre> module.exports = new MyWidget();</code></pre>
<p><code>parentWidget()</code> can be given the following values:</p> <p><code>parentWidget()</code> can be given the following values:</p>
<ul> <ul>
<li data-list-item-id="e8b62dcf10b3cfccc9f4bc80ded18346f"><code>left-pane</code> - This renders the widget on the left side of the <li><code>left-pane</code> - This renders the widget on the left side of the
screen where the note tree lives.</li> screen where the note tree lives.</li>
<li data-list-item-id="eeeef623e323425e2c362acb5fb5fcc91"><code>center-pane</code> - This renders the widget in the center of the <li><code>center-pane</code> - This renders the widget in the center of the
layout in the same location that notes and splits appear.</li> layout in the same location that notes and splits appear.</li>
<li data-list-item-id="e95ab9fba1601f210196b628eccc2e3d0"><code>note-detail-pane</code> - This renders the widget <em>with</em> the <li><code>note-detail-pane</code> - This renders the widget <em>with</em> the
note in the center pane. This means it can appear multiple times with splits.</li> note in the center pane. This means it can appear multiple times with splits.</li>
<li <li><code>right-pane</code> - This renders the widget to the right of any opened
data-list-item-id="e0f1f65f68ce610bcc85f51de7ff47f37"><code>right-pane</code> - This renders the widget to the right of any opened
notes.</li> notes.</li>
</ul> </ul>
<p><a href="#root/_help_s8alTXmpFR61">Reload</a> the application one last time. <p><a href="#root/_help_s8alTXmpFR61">Reload</a> the application one last time.

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

@@ -597,6 +597,13 @@
"type": "text", "type": "text",
"mime": "text/html", "mime": "text/html",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "VIcWnKGs0sMh",
"isInheritable": false,
"position": 10
},
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
@@ -624,13 +631,6 @@
"value": "notes", "value": "notes",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "VIcWnKGs0sMh",
"isInheritable": false,
"position": 50
} }
], ],
"format": "markdown", "format": "markdown",

2
docs/Developer Guide/Developer Guide/Documentation.md vendored
View File

@@ -1,5 +1,5 @@
# Documentation # Documentation
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/OdhZWHj05SLY/Documentation_image.png" width="205" height="162"> There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/kaFXA5t813qK/Documentation_image.png" width="205" height="162">
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>. * The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers. * The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.