trilium/README.md

Important

The TriliumNext team has received the original Trilium Notes repository (zadam/trilium). We will soon enter the process in which TriliumNext will become the original Trilium Notes again.

For now, we invite you to have a look at the TriliumNext repo. You should be able to migrate to TriliumNext without any problems from the original Trilium.

Thanks to @zadam for his original work and for allowing us to continue using the Trilium Notes name once again.

Trilium Notes

English | Chinese | Russian | Japanese | Italian

Trilium Notes is a hierarchical note taking application with focus on building large personal knowledge bases.

See screenshots for quick overview:

Ukraine is currently defending itself from Russian aggression, please consider donating to Ukrainian Army or humanitarian charities.

🎁 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
• 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 awesome-trilium for 3rd party themes, scripts, plugins and more.

🏗 Builds

Trilium is provided as either desktop application (Linux and Windows) or web application hosted on your server (Linux). Mac OS desktop build is available, but it is unsupported.

• If you want to use Trilium on the desktop, download binary release for your platform from latest release, unzip the package and run trilium executable.
• If you want to install Trilium on server, follow this page.
  • Currently only recent Chrome and Firefox are supported (tested) browsers.

Trilium is also provided as a Flatpak:

📝 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 Trilium.

💻 Contribute

Use a browser based dev environment

Or clone locally and run

npm install
npm run start-server

📢 Shoutouts

• CKEditor 5 - best WYSIWYG editor on the market, very interactive and listening team
• FancyTree - very feature rich tree library without real competition. Trilium 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

You can support Trilium using GitHub Sponsors, 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.