Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-10 07:15:51 +01:00
Code Issues Packages Projects Releases Activity

docs(dev): integrate architecture guide

Browse Source
This commit is contained in:
Elian Doran
2025-11-04 17:24:38 +02:00
parent 58ac325634
commit 7369f9d532
14 changed files with 392 additions and 315 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -56,6 +56,48 @@
"value": "bx bx-help-circle",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "poXkQfguuA0U",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "WOcw2SLH6tbX",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "gh7bpGYxajRS",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "Q2z6av6JZVWm",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "MEtfsqa5VwNi",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "9qPsTWBorUhQ",
"isInheritable": false,
"position": 90
}
],
"format": "markdown",

20
docs/User Guide/User Guide.md vendored
View File

@@ -1,13 +1,25 @@
# User Guide
Trilium is an open-source solution for note-taking and organizing a personal knowledge base. Use it locally on your desktop, or sync it with your self-hosted server to keep your notes everywhere you go.
For a quick overview of the application, visit our website at [triliumnotes.org](https://triliumnotes.org/).
> [!TIP]
> The same documentation can be accessed locally from within the Trilium Notes application by pressing <kbd>F1</kbd>.
## Getting started
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/Collections.md">Collections</a>.
2. Go through <a class="reference-link" href="User%20Guide/Basic%20Concepts%20and%20Features">Basic Concepts and Features</a>.
3. Understand <a class="reference-link" href="User%20Guide/Basic%20Concepts%20and%20Features/Notes.md">Notes</a>.
4. Browse through <a class="reference-link" href="User%20Guide/Collections.md">Collections</a>.
## Quick links
* <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
* <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
* <a class="reference-link" href="User%20Guide/Scripting/Script%20API/Frontend%20API">Frontend API</a> or <a class="reference-link" href="User%20Guide/Scripting/Script%20API/Backend%20API.dat">Backend API</a>
* [ETAPI reference](User%20Guide/Advanced%20Usage/ETAPI%20\(REST%20API\)/API%20Reference.dat)
## External links
* The [Trilium Notes website](https://triliumnotes.org/), for a quick presentation of the application.
* [Developer Guide](https://docs.triliumnotes.org/developer-guide/), to understand the architecture and processes behind the development of Trilium Notes.
* [GitHub Repository (TriliumNext/Trilium)](https://github.com/TriliumNext/Trilium/)