docs(guide): deduplicate home page with quick start

This commit is contained in:
Elian Doran 2025-10-29 22:00:31 +02:00
parent cfd55147df
commit 0bc86d7c75
No known key found for this signature in database
7 changed files with 97 additions and 152 deletions

View File

@ -1,8 +1,8 @@
<p>Zoom applies to the entire UI, including text.</p>
<p>On the desktop application, use the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_x3i7MxGccDuM">Global menu</a>&nbsp;to
<p>On the desktop application, use the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;to
zoom in/out.</p>
<p>On both web browser and the desktop, the keyboard shortcuts <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>+</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>-</kbd> can
be used.</p>
<h2>Adjusting the text size instead</h2>
<p>As an alternative to the zoom, the text size can be individually adjusted
by going to&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_4TIF1oA4VQRO">Options</a>&nbsp;<em>Appearance</em>.</p>
by going to&nbsp;<a class="reference-link" href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;<em>Appearance</em>.</p>

View File

@ -25,14 +25,14 @@
<p>Common request is to allow multiple users collaborate, share notes etc.
So far I'm resisting this because of these reasons:</p>
<ul>
<li data-list-item-id="eb800113d8b3ab1905b710e9e8ee0f12a">it's a huge feature, or rather a Pandora's box of collaboration features
<li>it's a huge feature, or rather a Pandora's box of collaboration features
like user management, permissions, conflict resolution, real-time editing
of a note by multiple people etc. This would be a huge amount of work.
Trilium Notes is project made mostly by one person in free time and that's
unlikely to change in the future.</li>
<li data-list-item-id="ee44659e9fabe03f5392ad0d6a3d1c246">given its size it would probably pivot the attention away from my main
<li>given its size it would probably pivot the attention away from my main
focus which is a personal note-taking</li>
<li data-list-item-id="e40e9d3e3682b4aa23621056270b76257">the assumption that only single person has access to the app simplifies
<li>the assumption that only single person has access to the app simplifies
many things, or just outright makes them possible. In multi-user app, our
<a
href="#root/_help_CdNpE2pqjmI6">scripting</a>support would be a XSS security hole, while with the single
@ -69,23 +69,21 @@
with probably more problems.</p>
<p>More detailed answer:</p>
<ul>
<li data-list-item-id="ed6f42f2a9c3d02e70f8c562d961bb63d"><a href="#root/_help_IakOLONlIfGI">clones</a> are what you might call "hard directory
<li><a href="#root/_help_IakOLONlIfGI">clones</a> are what you might call "hard directory
link" in filesystem lingo, but this concept is not implemented in any filesystem</li>
<li
data-list-item-id="ea08b9caa11abddfb48deb74d5b6f7388">filesystems make a distinction between directory and file while there's
<li>filesystems make a distinction between directory and file while there's
intentionally no such difference in Trilium</li>
<li data-list-item-id="e9c3473810cd4fe860b5824b714ced189">files are stored in no particular order and user can't change this</li>
<li
data-list-item-id="e168be7c32aff67053f0095dcd583da0f">Trilium allows storing note <a href="#root/_help_zEY4DaJG4YT5">attributes</a> which
could be represented in extended user attributes but their support differs
greatly among different filesystems / operating systems</li>
<li data-list-item-id="e86308cf2302c48ae3684f817ef921e46">Trilium makes links / relations between different notes which can be quickly
retrieved / navigated (e.g. for <a href="#root/_help_BCkXAVs63Ttv">note map</a>).
There's no such support in file systems which means these would have to
be stored in some kind of side-car files (mini-databases).</li>
<li data-list-item-id="ea23fb3e81afba708ad7da44c2feeb9be">Filesystems are generally not transactional. While this is not completely
required for a note-taking application, having transactions make it way
easier to keep notes and their metadata in predictable and consistent state.</li>
<li>files are stored in no particular order and user can't change this</li>
<li>Trilium allows storing note <a href="#root/_help_zEY4DaJG4YT5">attributes</a> which
could be represented in extended user attributes but their support differs
greatly among different filesystems / operating systems</li>
<li>Trilium makes links / relations between different notes which can be quickly
retrieved / navigated (e.g. for <a href="#root/_help_BCkXAVs63Ttv">note map</a>).
There's no such support in file systems which means these would have to
be stored in some kind of side-car files (mini-databases).</li>
<li>Filesystems are generally not transactional. While this is not completely
required for a note-taking application, having transactions make it way
easier to keep notes and their metadata in predictable and consistent state.</li>
</ul>
<h2>Search-related Questions</h2>
<h3>Why does search sometimes find results with typos?</h3>
@ -98,9 +96,9 @@
<h3>How can I search for notes when I'm not sure of the exact spelling?</h3>
<p>Use the fuzzy search operators:</p>
<ul>
<li data-list-item-id="e91e70fef9031d168e95d28af8eb4c8ed"><code>#title ~= "projct"</code> - finds notes with titles like "project"
<li><code>#title ~= "projct"</code> - finds notes with titles like "project"
despite the typo</li>
<li data-list-item-id="ee1eddc61b08bb2497a4eed03784cb845"><code>note.content ~* "algoritm"</code> - finds content containing "algorithm"
<li><code>note.content ~* "algoritm"</code> - finds content containing "algorithm"
or similar words</li>
</ul>
<h3>Why do some search results appear before others with lower scores?</h3>
@ -110,9 +108,9 @@
factors.</p>
<h3>How can I make my searches faster?</h3>
<ol>
<li data-list-item-id="e31e798496de72ab1d1c890e5143bdcf3">Use the "Fast search" option to search only titles and attributes (not
<li>Use the "Fast search" option to search only titles and attributes (not
content)</li>
<li data-list-item-id="e8659a04d4b8d1ce16740520524f51dd1">Limit search scope using the "Ancestor" field</li>
<li data-list-item-id="e71c171a22ad97a012f3fe0b4934e9eed">Set a result limit to prevent loading too many results</li>
<li data-list-item-id="e345d6d8caa359211458da8597d0aeb07">For large databases, consider archiving old notes to reduce search scope</li>
<li>Limit search scope using the "Ancestor" field</li>
<li>Set a result limit to prevent loading too many results</li>
<li>For large databases, consider archiving old notes to reduce search scope</li>
</ol>

View File

@ -1,4 +1,4 @@
<p>As an alternative to <a href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/WOcw2SLH6tbX/_help_Dgg7bR3b6K9j">hosting your own Trilium instance</a>,
<p>As an alternative to <a href="#root/_help_Dgg7bR3b6K9j">hosting your own Trilium instance</a>,
there are two services out there that provide out of the box support for
Trilium.</p>
<aside class="admonition important">
@ -24,10 +24,10 @@
<p>Trilium.cc usually runs several versions behind Trilium releases.</p>
</aside>
<h2>Matching your version with the cloud instance</h2>
<p>Please note that once you set up&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_cbkrhQjrkKrh">Synchronization</a>&nbsp;between
a cloud instance and <a href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_poXkQfguuA0U">desktop</a> clients,
it's important that the version of the desktop application and the server
match up.</p>
<p>Please note that once you set up&nbsp;<a class="reference-link" href="#root/_help_cbkrhQjrkKrh">Synchronization</a>&nbsp;between
a cloud instance and <a href="#root/_help_poXkQfguuA0U">desktop</a> clients, it's
important that the version of the desktop application and the server match
up.</p>
<p>When setting up a cloud instance, it's best to check the version of the
server by accessing it via a web browser and going to the <em>About</em> section.
It's best that both the desktop and the server have the same <em>App version</em>;

View File

@ -1,19 +1,20 @@
<h2>Choose the setup</h2>
<p><strong>Local only desktop/laptop</strong> - Allows a single instance on
a desktop and will save the notes locally on that desktop.</p>
<ol>
<li><a href="#root/_help_poXkQfguuA0U">Desktop installation</a>
<ul>
<li data-list-item-id="ee2e7087616538e07480af0ce50381d98"><a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_poXkQfguuA0U">Desktop Installation</a>
</li>
</ol>
</ul>
<p><strong>Server with web only access</strong> - Installs the application
on the server and allows access from any web browser on any device, including
mobile.</p>
<ol>
<li><a href="#root/_help_WOcw2SLH6tbX">Server installation</a>
</li>
<li><a href="#root/_help_RDslemsQ6gCp">Mobile frontend</a> (optional)</li>
<li><a href="https://www.pikapods.com/pods?run=trilium-next">PikaPods managed hosting</a>
<li data-list-item-id="e9d59a2efb80973c48e2cc94132b817a5"><a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_WOcw2SLH6tbX">Server Installation</a>
</li>
<li data-list-item-id="e1fd3aeaa6bf30f9b708949b02842c9a1"><a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_RDslemsQ6gCp">Mobile Frontend</a>&nbsp;(optional)</li>
<li
data-list-item-id="e64af7467dba8292bcc8e7a3f983d55bc"><a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/WOcw2SLH6tbX/_help_yeEaYqosGLSh">Third-party cloud hosting</a>
</li>
</ol>
<p><strong>Combination of server and desktop/laptop</strong> - Install the
application on both a server, for web access and data synchronisation,
@ -22,11 +23,12 @@
desktop application will sync and store the data locally so that it can
be used when offline.</p>
<ol>
<li><a href="#root/_help_WOcw2SLH6tbX">Server installation</a>
</li>
<li><a href="#root/_help_RDslemsQ6gCp">Mobile frontend</a> (optional)</li>
<li><a href="#root/_help_poXkQfguuA0U">Desktop installation</a>
</li>
<li><a href="#root/_help_cbkrhQjrkKrh">Synchronization</a>
<li data-list-item-id="e8824368037a294899c0739909228e17e"><a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_WOcw2SLH6tbX">Server Installation</a>
</li>
<li data-list-item-id="e31ad4d2c8b4925e73497792824b038e3"><a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_RDslemsQ6gCp">Mobile Frontend</a>&nbsp;(optional)</li>
<li
data-list-item-id="eabfcd159a74c0c29b79e9b2e1c57f3c8"><a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_poXkQfguuA0U">Desktop Installation</a>
</li>
<li data-list-item-id="e4093e08cdbff3b351d908c16e0f5f705"><a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_cbkrhQjrkKrh">Synchronization</a>
</li>
</ol>

View File

@ -15,52 +15,17 @@
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "poXkQfguuA0U",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "WOcw2SLH6tbX",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "RDslemsQ6gCp",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "cbkrhQjrkKrh",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "BFs8mudNFgCS",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "yeEaYqosGLSh",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 70
},
@ -77,6 +42,13 @@
"value": "promoted,alias=Slug,single,text",
"isInheritable": true,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "s3YCWHBfmYuM",
"isInheritable": false,
"position": 80
}
],
"format": "markdown",
@ -1136,16 +1108,16 @@
{
"type": "relation",
"name": "internalLink",
"value": "cbkrhQjrkKrh",
"value": "poXkQfguuA0U",
"isInheritable": false,
"position": 10
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "poXkQfguuA0U",
"value": "cbkrhQjrkKrh",
"isInheritable": false,
"position": 10
"position": 30
},
{
"type": "label",
@ -3063,6 +3035,20 @@
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "x3i7MxGccDuM",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "4TIF1oA4VQRO",
"isInheritable": false,
"position": 20
},
{
"type": "label",
"name": "iconClass",
@ -3076,20 +3062,6 @@
"value": "zoom",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "x3i7MxGccDuM",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "4TIF1oA4VQRO",
"isInheritable": false,
"position": 40
}
],
"format": "markdown",
@ -3111,15 +3083,7 @@
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "shareAlias",
"value": "quick-edit",
"isInheritable": false,
"position": 20
}
],
"attributes": [],
"format": "markdown",
"dataFileName": "Quick edit.md",
"attachments": [
@ -5349,13 +5313,6 @@
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "cbkrhQjrkKrh",
"isInheritable": false,
"position": 40
},
{
"type": "label",
"name": "shareAlias",
@ -5369,6 +5326,20 @@
"value": "bx bx-run",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "yeEaYqosGLSh",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "cbkrhQjrkKrh",
"isInheritable": false,
"position": 60
}
],
"format": "markdown",

View File

@ -6,34 +6,8 @@ For a quick overview of the application, visit our website at [triliumnotes.org]
> [!TIP]
> The same documentation can be accessed locally from within the Trilium Notes application by pressing <kbd>F1</kbd>.
## Documentation
## Getting started
This [wiki](https://github.com/zadam/trilium/wiki) contains additional and more in-depth information on some topics. See the sidebar for listing of all available pages.
## Quick Start
### Choose the setup
**Local only desktop/laptop** - Allows a single instance on a desktop and will save the notes locally on that desktop.
* <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
**Server with web only access** - Installs the application on the server and allows access from any web browser on any device, including mobile.
1. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
2. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend.md">Mobile Frontend</a> (optional)
3. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/Third-party%20cloud%20hosting.md">Third-party cloud hosting</a>
**Combination of server and desktop/laptop** - Install the application on both a server, for web access and data synchronization, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline.
1. <a class="reference-link" href="/Server installation">[missing note]</a>
<a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
2. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend.md">Mobile Frontend</a> (optional)
3. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
4. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Synchronization.md">Synchronization</a><a class="reference-link" href="/Synchronization">[missing note]</a>
### Basic concepts
1. Understand <a class="reference-link" href="User%20Guide/Basic%20Concepts%20and%20Features/Notes.md">Notes</a>.<a class="reference-link" href="/Note">[missing note]</a>
2. Browse through <a class="reference-link" href="User%20Guide/Note%20Types/Collections.md">Collections</a>.<a class="reference-link" href="/Screenshot tour">[missing note]</a>
1. See <a class="reference-link" href="User%20Guide/Quick%20Start.md">Quick Start</a>.
2. Understand <a class="reference-link" href="User%20Guide/Basic%20Concepts%20and%20Features/Notes.md">Notes</a>.
3. Browse through <a class="reference-link" href="User%20Guide/Note%20Types/Collections.md">Collections</a>.

View File

@ -3,17 +3,17 @@
**Local only desktop/laptop** - Allows a single instance on a desktop and will save the notes locally on that desktop.
1. [Desktop installation](Installation%20%26%20Setup/Desktop%20Installation.md)
* <a class="reference-link" href="Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
**Server with web only access** - Installs the application on the server and allows access from any web browser on any device, including mobile.
1. [Server installation](Installation%20%26%20Setup/Server%20Installation.md)
2. [Mobile frontend](Installation%20%26%20Setup/Mobile%20Frontend.md) (optional)
3. [PikaPods managed hosting](https://www.pikapods.com/pods?run=trilium-next)
1. <a class="reference-link" href="Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
2. <a class="reference-link" href="Installation%20%26%20Setup/Mobile%20Frontend.md">Mobile Frontend</a> (optional)
3. <a class="reference-link" href="Installation%20%26%20Setup/Server%20Installation/Third-party%20cloud%20hosting.md">Third-party cloud hosting</a>
**Combination of server and desktop/laptop** - Install the application on both a server, for web access and data synchronisation, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline.
1. [Server installation](Installation%20%26%20Setup/Server%20Installation.md)
2. [Mobile frontend](Installation%20%26%20Setup/Mobile%20Frontend.md) (optional)
3. [Desktop installation](Installation%20%26%20Setup/Desktop%20Installation.md)
4. [Synchronization](Installation%20%26%20Setup/Synchronization.md)
1. <a class="reference-link" href="Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
2. <a class="reference-link" href="Installation%20%26%20Setup/Mobile%20Frontend.md">Mobile Frontend</a> (optional)
3. <a class="reference-link" href="Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
4. <a class="reference-link" href="Installation%20%26%20Setup/Synchronization.md">Synchronization</a>