You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 24, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+36-5Lines changed: 36 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,17 @@ There are no special migration steps to migrate from a zadam/Trilium instance to
20
20
21
21
Versions up to and including [v0.90.4](https://github.com/TriliumNext/Notes/releases/tag/v0.90.4) are compatible with the latest zadam/trilium version of [v0.63.7](https://github.com/zadam/trilium/releases/tag/v0.63.7). Any later versions of TriliumNext have their sync versions incremented.
22
22
23
+
## Documentation
24
+
25
+
We're currently in the progress of moving the documentation to in-app (hit the `F1` key within Trilium). As a result, there may be some missing parts until we've completed the migration. If you'd prefer to navigate through the documentation within GitHub, you can navigate the [User Guide](./docs/User%20Guide/User%20Guide/) documentation.
26
+
27
+
Below are some quick links for your convenience to navigate the documentation:
-[Concepts and Features - Note](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
32
+
33
+
23
34
## 💬 Discuss with us
24
35
25
36
Feel free to join our official conversations. We would love to hear what features, suggestions, or issues you may have!
@@ -63,7 +74,7 @@ Feel free to join our official conversations. We would love to hear what feature
63
74
64
75
To use TriliumNext on your desktop machine (Linux, MacOS, and Windows) you have a few options:
65
76
66
-
* Download the binary release for your platform from the [latest release page](https://github.com/TriliumNext/Notes/releases/latest), unzip the package and run the ```trilium``` executable.
77
+
* Download the binary release for your platform from the [latest release page](https://github.com/TriliumNext/Notes/releases/latest), unzip the package and run the `trilium` executable.
67
78
* Access TriliumNext via the web interface of a server installation (see below)
68
79
* Currently only the latest versions of Chrome & Firefox are supported (and tested).
69
80
* TriliumNext is also provided as a Flatpak, but not yet published on FlatHub.
@@ -90,18 +101,38 @@ You can also read [Patterns of personal knowledge base](https://triliumnext.gith
90
101
91
102
### Code
92
103
104
+
Download the repository, install dependencies using `pnpm` and then run the server (available at http://localhost:8080):
For more details, see the [development docs](https://github.com/TriliumNext/Notes/blob/develop/docs/Developer%20Guide/Developer%20Guide/Building%20and%20deployment/Running%20a%20development%20build.md).
101
132
102
-
### Documentation
133
+
### Developer Documentation
103
134
104
-
See the [documentation guide](https://github.com/TriliumNext/Notes/blob/develop/docs/Developer%20Guide/Developer%20Guide/Documentation.md) for details.
135
+
Please view the [documentation guide](./docs/Developer%20Guide/Developer%20Guide/Environment%20Setup.md) for details. If you have more questions, feel free to reach out via the links described in the "Discuss with us" section above.
0 commit comments