2017-12-27 01:55:40 +08:00
# Trilium Notes
2018-03-12 06:46:54 +08:00
[](https://gitter.im/trilium-notes/Lobby?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2017-12-27 01:55:40 +08:00
Trilium Notes is a hierarchical note taking application. Picture tells a thousand words:
2017-12-25 11:33:36 +08:00
2017-12-25 11:34:57 +08:00
2017-12-25 11:47:06 +08:00
2018-08-30 17:56:12 +08:00
See other pictures in [screenshot tour ](https://github.com/zadam/trilium/wiki/Screenshot-tour ).
2017-12-25 11:47:06 +08:00
## Features
2018-08-30 17:56:12 +08:00
* Notes can be arranged into arbitrarily deep hierarchy (tree)
2017-12-25 21:37:40 +08:00
* Notes can have more than 1 parents - see [cloning ](https://github.com/zadam/trilium/wiki/Cloning-notes )
2018-09-02 17:05:07 +08:00
* Rich WYSIWYG note editing including e.g. tables and images with markdown [autoformat ](https://github.com/zadam/trilium/wiki/Text-editor#autoformat )
2018-10-13 00:38:57 +08:00
* Support for editing [notes with source code ](https://github.com/zadam/trilium/wiki/Code-notes ), including syntax highlighting
2017-12-27 00:08:23 +08:00
* Fast and easy [navigation between notes ](https://github.com/zadam/trilium/wiki/Note-navigation )
2018-08-30 17:56:12 +08:00
* Seamless [note versioning ](https://github.com/zadam/trilium/wiki/Note-revisions )
2018-10-13 00:38:57 +08:00
* Note [attributes ](https://github.com/zadam/trilium/wiki/Attributes ) can be used for note organization, querying and advanced [scripting ](https://github.com/zadam/trilium/wiki/Scripts )
2018-08-30 17:56:12 +08:00
* [Synchronization ](https://github.com/zadam/trilium/wiki/Synchronization ) with self-hosted sync server
2017-12-25 11:47:06 +08:00
* Strong [note encryption ](https://github.com/zadam/trilium/wiki/Protected-notes )
2018-08-30 17:56:12 +08:00
* [Scripting ](https://github.com/zadam/trilium/wiki/Scripts ) - see [Advanced showcases ](https://github.com/zadam/trilium/wiki/Advanced-showcases )
2018-08-31 03:57:14 +08:00
* Scales well in both usability and performance upwards of 100 000 notes
2018-09-01 23:50:49 +08:00
* [Night theme ](https://github.com/zadam/trilium/wiki/Themes )
2018-09-04 03:06:24 +08:00
* [Markdown import & export ](https://github.com/zadam/trilium/wiki/Markdown )
2017-12-25 11:47:06 +08:00
## Builds
2018-09-01 17:04:31 +08:00
Trilium is provided as either desktop application ([Electron](https://electronjs.org)-based) or web application hosted on your server.
2018-09-07 19:55:13 +08:00
* If you want to use Trilium on the desktop, download binary release for your platform (currently Linux and Windows are supported) from [latest release ](https://github.com/zadam/trilium/releases/latest ), unzip the package and run ```trilium``` executable.
2018-08-31 03:57:14 +08:00
* If you want to install Trilium on server, follow [this page ](https://github.com/zadam/trilium/wiki/Server-installation ).
* Currently only recent Chrome and Firefox are supported (tested) browsers.
2017-12-25 11:47:06 +08:00
2018-08-30 17:56:12 +08:00
## Status
2018-09-01 17:04:31 +08:00
Trilium is beta quality software. While it is reasonably feature complete and is tested by its author, it lacks proper testing by more users. It's not yet recommended for daily use, but testing and experimentation is encouraged.
2018-08-30 17:56:12 +08:00
2017-12-25 11:47:06 +08:00
## Documentation
2018-08-30 17:56:12 +08:00
[See wiki for complete list of documentation pages. ](https://github.com/zadam/trilium/wiki/ )
