TriliumNext Notes

English | Chinese | Russian | Japanese | Italian | Spanish

TriliumNext Notes is an open-source, cross-platform hierarchical note taking application with focus on building large personal knowledge bases.

See screenshots for quick overview:

⚠️ Why TriliumNext?

The original Trilium project is in maintenance mode

Migrating from Trilium?

There are no special migration steps to migrate from a zadam/Trilium instance to a TriliumNext/Notes instance. Simply install TriliumNext/Notes as usual and it will use your existing database.

Versions up to and including v0.90.4 are compatible with the latest zadam/trilium version of v0.63.7. Any later versions of TriliumNext have their sync versions incremented.

Documentation

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 documentation.

Below are some quick links for your convenience to navigate the documentation:

• Server installation
  • Docker installation
• Upgrading TriliumNext
• Concepts and Features - Note

💬 Discuss with us

Feel free to join our official conversations. We would love to hear what features, suggestions, or issues you may have!

• Matrix (For synchronous discussions)
  • The General Matrix room is also bridged to XMPP
• Github Discussions (For Asynchronous discussions)
• Wiki (For common how-to questions and user guides)

🎁 Features

• Notes can be arranged into arbitrarily deep tree. Single note can be placed into multiple places in the tree (see cloning)
• Rich WYSIWYG note editing including e.g. tables, images and math with markdown autoformat
• Support for editing notes with source code, including syntax highlighting
• Fast and easy navigation between notes, full text search and note hoisting
• Seamless note versioning
• Note attributes can be used for note organization, querying and advanced scripting
• Direct OpenID and TOTP integration for more secure login
• Synchronization with self-hosted sync server
  • there's a 3rd party service for hosting synchronisation server
• Sharing (publishing) notes to public internet
• Strong note encryption with per-note granularity
• Sketching diagrams with built-in Excalidraw (note type "canvas")
• Relation maps and link maps for visualizing notes and their relations
• Scripting - see Advanced showcases
• REST API for automation
• Scales well in both usability and performance upwards of 100 000 notes
• Touch optimized mobile frontend for smartphones and tablets
• Night theme
• Evernote and Markdown import & export
• Web Clipper for easy saving of web content

✨ Check out the following third-party resources/communities for more TriliumNext related goodies:

• awesome-trilium for 3rd party themes, scripts, plugins and more.
• TriliumRocks! for tutorials, guides, and much more.

🏗 Installation

Desktop

To use TriliumNext on your desktop machine (Linux, MacOS, and Windows) you have a few options:

• Download the binary release for your platform from the latest release page, unzip the package and run the trilium executable.
• Access TriliumNext via the web interface of a server installation (see below)
  • Currently only the latest versions of Chrome & Firefox are supported (and tested).
• TriliumNext is also provided as a Flatpak, but not yet published on FlatHub.

Mobile

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).

If you prefer a native Android app, you can use TriliumDroid. Report bugs and missing features at their repository.

See issue https://github.com/TriliumNext/Notes/issues/72 for more information on mobile app support.

Server

To install TriliumNext on your own server (including via Docker from Dockerhub) follow the server installation docs.

📝 Documentation

See wiki for complete list of documentation pages.

You can also read Patterns of personal knowledge base to get some inspiration on how you might use TriliumNext.

💻 Contribute

Code

Download the repository, install dependencies using pnpm and then run the server (available at http://localhost:8080):

git clone https://github.com/TriliumNext/Notes.git
cd Notes
pnpm install
pnpm run server:start

Documentation

Download the repository, install dependencies using pnpm and then run the environment required to edit the documentation:

git clone https://github.com/TriliumNext/Notes.git
cd Notes
pnpm install
pnpm nx run edit-docs:serve

Building the Executable

Download the repository, install dependencies using pnpm and then build the desktop app for Windows:

git clone https://github.com/TriliumNext/Notes.git
cd Notes
pnpm install
pnpm nx --project=desktop electron-forge:make -- --arch=x64 --platform=win32

For more details, see the development docs.

Developer Documentation

Please view the documentation guide for details. If you have more questions, feel free to reach out via the links described in the "Discuss with us" section above.

👏 Shoutouts

• CKEditor 5 - best WYSIWYG editor on the market, very interactive and listening team
• FancyTree - very feature rich tree library without real competition. TriliumNext Notes would not be the same without it.
• CodeMirror - code editor with support for huge amount of languages
• jsPlumb - visual connectivity library without competition. Used in relation maps and link maps

🤝 Support

Support for the TriliumNext organization will be possible in the near future. For now, you can:

• Support continued development on TriliumNext by supporting our developers: eliandoran (See the repository insights for a full list)
• Show a token of gratitude to the original Trilium developer (zadam) via PayPal or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2).

🔑 License

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.