|
1 | 1 | > [!IMPORTANT] |
2 | | -> The issues section was relocated to https://github.com/TriliumNext/trilium. |
3 | | -
|
4 | | -# TriliumNext Notes |
5 | | - |
6 | | - |
7 | | - |
8 | | - |
9 | | -[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp) |
10 | | - |
11 | | -[English](./README.md) | [Chinese](./docs/README-ZH_CN.md) | [Russian](./docs/README.ru.md) | [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) | [Spanish](./docs/README.es.md) |
12 | | - |
13 | | -TriliumNext Notes is a free and open-source, cross-platform hierarchical note taking application with focus on building large personal knowledge bases. |
14 | | - |
15 | | -See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for quick overview: |
16 | | - |
17 | | -<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a> |
18 | | - |
19 | | -## 🎁 Features |
20 | | - |
21 | | -* Notes can be arranged into arbitrarily deep tree. Single note can be placed into multiple places in the tree (see [cloning](https://triliumnext.github.io/Docs/Wiki/cloning-notes)) |
22 | | -* Rich WYSIWYG note editor including e.g. tables, images and [math](https://triliumnext.github.io/Docs/Wiki/text-notes) with markdown [autoformat](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat) |
23 | | -* Support for editing [notes with source code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax highlighting |
24 | | -* Fast and easy [navigation between notes](https://triliumnext.github.io/Docs/Wiki/note-navigation), full text search and [note hoisting](https://triliumnext.github.io/Docs/Wiki/note-hoisting) |
25 | | -* Seamless [note versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions) |
26 | | -* Note [attributes](https://triliumnext.github.io/Docs/Wiki/attributes) can be used for note organization, querying and advanced [scripting](https://triliumnext.github.io/Docs/Wiki/scripts) |
27 | | -* UI available in English, German, Spanish, French, Romanian, and Chinese (simplified and traditional) |
28 | | -* Direct [OpenID and TOTP integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md) for more secure login |
29 | | -* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization) with self-hosted sync server |
30 | | - * there's a [3rd party service for hosting synchronisation server](https://trilium.cc/paid-hosting) |
31 | | -* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes to public internet |
32 | | -* Strong [note encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with per-note granularity |
33 | | -* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type "canvas") |
34 | | -* [Relation maps](https://triliumnext.github.io/Docs/Wiki/relation-map) and [link maps](https://triliumnext.github.io/Docs/Wiki/link-map) for visualizing notes and their relations |
35 | | -* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/) |
36 | | -* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with location pins and GPX tracks |
37 | | -* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases) |
38 | | -* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation |
39 | | -* Scales well in both usability and performance upwards of 100 000 notes |
40 | | -* Touch optimized [mobile frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for smartphones and tablets |
41 | | -* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support for user themes |
42 | | -* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and [Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown) |
43 | | -* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy saving of web content |
44 | | -* Customizable UI (sidebar buttons, user-defined widgets, ...) |
45 | | -* [Metrics](./docs/User%20Guide/User%20Guide/Advanced%20Usage/Metrics.md), along with a [Grafana Dashboard](./docs/User%20Guide/User%20Guide/Advanced%20Usage/Metrics/grafana-dashboard.json) |
46 | | - |
47 | | -✨ Check out the following third-party resources/communities for more TriliumNext related goodies: |
48 | | - |
49 | | -- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party themes, scripts, plugins and more. |
50 | | -- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more. |
51 | | - |
52 | | -## ⚠️ Why TriliumNext? |
53 | | - |
54 | | -[The original Trilium project is in maintenance mode](https://github.com/zadam/trilium/issues/4620). |
55 | | - |
56 | | -### Migrating from Trilium? |
57 | | - |
58 | | -There are no special migration steps to migrate from a zadam/Trilium instance to a TriliumNext/Notes instance. Simply [install TriliumNext/Notes](#-installation) as usual and it will use your existing database. |
59 | | - |
60 | | -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. |
61 | | - |
62 | | -## 📖 Documentation |
63 | | - |
64 | | -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. |
65 | | - |
66 | | -Below are some quick links for your convenience to navigate the documentation: |
67 | | -- [Server installation](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md) |
68 | | - - [Docker installation](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md) |
69 | | -- [Upgrading TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md) |
70 | | -- [Concepts and Features - Note](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md) |
71 | | -- [Patterns of personal knowledge base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge) |
72 | | - |
73 | | -Until we finish reorganizing the documentation, you may also want to [browse the old documentation](https://triliumnext.github.io/Docs). |
74 | | - |
75 | | -## 💬 Discuss with us |
76 | | - |
77 | | -Feel free to join our official conversations. We would love to hear what features, suggestions, or issues you may have! |
78 | | - |
79 | | -- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous discussions.) |
80 | | - - The `General` Matrix room is also bridged to [XMPP ](xmpp:[email protected]?join) |
81 | | -- [Github Discussions](https://github.com/TriliumNext/Notes/discussions) (For asynchronous discussions.) |
82 | | -- [Github Issues](https://github.com/TriliumNext/Notes/issues) (For bug reports and feature requests.) |
83 | | - |
84 | | -## 🏗 Installation |
85 | | - |
86 | | -### Windows / MacOS |
87 | | - |
88 | | -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. |
89 | | - |
90 | | -### Linux |
91 | | - |
92 | | -If your distribution is listed in the table below, use your distribution's package. |
93 | | - |
94 | | -[](https://repology.org/project/triliumnext/versions) |
95 | | - |
96 | | -You may also 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. |
97 | | - |
98 | | -TriliumNext is also provided as a Flatpak, but not yet published on FlatHub. |
99 | | - |
100 | | -### Browser (any OS) |
101 | | - |
102 | | -If you use a server installation (see below), you can directly access the web interface (which is almost identical to the desktop app). |
103 | | - |
104 | | -Currently only the latest versions of Chrome & Firefox are supported (and tested). |
105 | | - |
106 | | -### Mobile |
107 | | - |
108 | | -To use TriliumNext on a mobile device, you can use a mobile web browser to access the mobile interface of a server installation (see below). |
109 | | - |
110 | | -If you prefer a native Android app, you can use [TriliumDroid](https://apt.izzysoft.de/fdroid/index/apk/eu.fliegendewurst.triliumdroid). Report bugs and missing features at [their repository](https://github.com/FliegendeWurst/TriliumDroid). |
111 | | - |
112 | | -See issue https://github.com/TriliumNext/Notes/issues/72 for more information on mobile app support. |
113 | | - |
114 | | -### Server |
115 | | - |
116 | | -To install TriliumNext on your own server (including via Docker from [Dockerhub](https://hub.docker.com/r/triliumnext/notes)) follow [the server installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation). |
117 | | - |
118 | | - |
119 | | -## 💻 Contribute |
120 | | - |
121 | | -### Code |
122 | | - |
123 | | -Download the repository, install dependencies using `pnpm` and then run the server (available at http://localhost:8080): |
124 | | -```shell |
125 | | -git clone https://github.com/TriliumNext/Notes.git |
126 | | -cd Notes |
127 | | -pnpm install |
128 | | -pnpm run server:start |
129 | | -``` |
130 | | - |
131 | | -### Documentation |
132 | | - |
133 | | -Download the repository, install dependencies using `pnpm` and then run the environment required to edit the documentation: |
134 | | -```shell |
135 | | -git clone https://github.com/TriliumNext/Notes.git |
136 | | -cd Notes |
137 | | -pnpm install |
138 | | -pnpm nx run edit-docs:edit-docs |
139 | | -``` |
140 | | - |
141 | | -### Building the Executable |
142 | | -Download the repository, install dependencies using `pnpm` and then build the desktop app for Windows: |
143 | | -```shell |
144 | | -git clone https://github.com/TriliumNext/Notes.git |
145 | | -cd Notes |
146 | | -pnpm install |
147 | | -pnpm nx --project=desktop electron-forge:make -- --arch=x64 --platform=win32 |
148 | | -``` |
149 | | - |
150 | | -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). |
151 | | - |
152 | | -### Developer Documentation |
153 | | - |
154 | | -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. |
155 | | - |
156 | | -## 👏 Shoutouts |
157 | | - |
158 | | -* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - best WYSIWYG editor on the market, very interactive and listening team |
159 | | -* [FancyTree](https://github.com/mar10/fancytree) - very feature rich tree library without real competition. TriliumNext Notes would not be the same without it. |
160 | | -* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with support for huge amount of languages |
161 | | -* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library without competition. Used in [relation maps](https://triliumnext.github.io/Docs/Wiki/relation-map.html) and [link maps](https://triliumnext.github.io/Docs/Wiki/note-map.html#link-map) |
162 | | - |
163 | | -## 🤝 Support |
164 | | - |
165 | | -Support for the TriliumNext organization will be possible in the near future. For now, you can: |
166 | | -- Support continued development on TriliumNext by supporting our developers: [eliandoran](https://github.com/sponsors/eliandoran) (See the [repository insights]([developers]([url](https://github.com/TriliumNext/Notes/graphs/contributors))) for a full list) |
167 | | -- Show a token of gratitude to the original Trilium developer ([zadam](https://github.com/sponsors/zadam)) via [PayPal](https://paypal.me/za4am) or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2). |
168 | | - |
169 | | - |
170 | | -## 🔑 License |
171 | | - |
172 | | -Copyright 2017-2025 zadam, Elian Doran, and other contributors |
173 | | - |
174 | | -This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. |
| 2 | +> TriliumNext started as a fork of the original Trilium repository (`zadam/trilium`). @zadam transferred the original repo to us so the work will continue in https://github.com/TriliumNext/trilium. |
0 commit comments