Trilium README

The project's README from github.com/TriliumNext/Trilium. As one markdown file: README.md.

Trilium Notes

GitHub Sponsors LiberaPay patrons
Docker Pulls GitHub Downloads (all assets, all releases)
Translation status

Arabic | Chinese (Simplified Han script) | Chinese (Traditional Han script) | Czech | English (United Kingdom) | English | French | German | Greek | Indonesian | Irish | Italian | Japanese | Korean | Polish | Romanian | Russian | Spanish | Ukrainian | Urdu | Uyghur

Trilium Notes is a free and open-source, cross-platform hierarchical note taking application with focus on building large personal knowledge bases.

Looking for "Trillium Notes"? The project's canonical spelling is "Trilium Notes", with one l.

Trilium Screenshot

⏬ Download

📚 Documentation

Visit our comprehensive documentation at docs.triliumnotes.org

Our documentation is available in multiple formats:

🎁 Features

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

❓Why TriliumNext?

The original Trilium developer (Zadam) has graciously given the Trilium repository to the community project which resides at https://github.com/TriliumNext

⬆️Migrating from Zadam/Trilium?

There are no special migration steps to migrate from a zadam/Trilium instance to a TriliumNext/Trilium instance. Simply install TriliumNext/Trilium 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/Trilium have their sync versions incremented which prevents direct migration.

💬 Discuss with us

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

🏗 Installation

Windows / MacOS

Download the binary release for your platform from the latest release page, unzip the package and run the trilium executable.

Linux

If your distribution is listed in the table below, use your distribution's package.

Packaging status

You may also download the binary release for your platform from the latest release page, unzip the package and run the trilium executable.

TriliumNext is also provided as a Flatpak, but not yet published on FlatHub.

Browser (any OS)

If you use a server installation (see below), you can directly access the web interface (which is almost identical to the desktop app).

Currently only the latest versions of Chrome & Firefox are supported (and tested).

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

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

TriliumDroid

If you prefer a native Android app, you can use TriliumDroid. Report bugs and missing features at their repository. Note: It is best to disable automatic updates on your server installation (see below) when using TriliumDroid since the sync version must match between Trilium and TriliumDroid.

Pocket Trilium

If you want a full-featured native Android app, check out Pocket Trilium. It runs a complete Trilium instance on your phone, supports full offline use, and allows you to sync with your server.

Trinote

If you want a native iOS app, you can use Trinote, an open-source client for your self-hosted Trilium / TriliumNext server. It lets you browse and organize your note tree, search for notes on the server, read and edit all note types (text, code, mindmap, spreadsheet, geomap, canvas, etc.), and keeps notes available and editable offline. Here's the repo if you're interested in contributing and here's the discord server if you have any feedback or suggestions you want to discuss.

Server

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

💻 Contribute

Translations

If you are a native speaker, help us translate Trilium by heading over to our Weblate page.

Here's the language coverage we have so far:

Translation status

Code

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

git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
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/Trilium.git
cd Trilium
pnpm install
pnpm edit-docs:edit-docs

Alternatively, if you have Nix installed:

# Run directly
nix run .#edit-docs

# Or install to your profile
nix profile install .#edit-docs
trilium-edit-docs

Building the Executable

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

git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm run --filter 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.

💖 Sponsors

NetPerfect logo
NetPerfect

EV certificate & Windows CI
CKEditor logo
CKEditor

Premium editor features
Dosu logo
Dosu

Automated GitHub support

👏 Shoutouts

Trilium would not be possible without the technologies behind it:

🤝 Support

Trilium is built and maintained with hundreds of hours of work. Your support keeps it open-source, improves features, and covers costs such as hosting.

Consider supporting the main developer (eliandoran) of the application via:

🔑 License

Copyright 2017-2025 zadam, Elian Doran, and other contributors

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.

Trilium (TriliumNext/Trilium)

Searching Database…

38.4K ·GitHub
这是什么?Trilium Notes 是一款免费、开源、跨平台的层级式笔记应用,专为构建大型个人知识库而设计。
这是桌面应用、服务器,还是两者都是?它既可以作为独立的桌面应用运行(Windows/macOS/Linux),也可以作为自托管服务器运行,通过浏览器访问,其界面与桌面应用几乎一致,还可以在两者之间进行同步。
我该怎么让它运行起来?下载适用于你操作系统的二进制发行版,解压后运行 trilium 可执行文件;在 Linux 上,你也可以使用发行版的软件包或 Flatpak;如果用作服务器,可以按照服务器安装文档,通过 Dockerhub 上的 Docker 进行部署。
有官方的手机应用吗?没有官方的应用。手机访问的方式是:通过浏览器访问你服务器的移动端界面,或使用第三方应用,如 TriliumDroid(Android)、Pocket Trilium(Android,支持离线)和 Trinote(iOS)。
支持哪些浏览器和操作系统?桌面版支持 Windows、macOS 和 Linux;通过浏览器访问时,仅对 Chrome 和 Firefox 的最新版本进行了测试并提供支持。
如果最初的开发者 Zadam 离开了项目,笔记会怎么样?Zadam 已将代码仓库移交给社区,现由社区以 TriliumNext/Trilium 的名义继续维护;现有的 zadam/Trilium 数据库可以直接使用,无需迁移步骤(但需符合 README 中注明的同步版本兼容性要求)。
笔记能否同时放在目录树的多个位置?可以。一条笔记可以克隆到层级结构中的多个位置,从而同时出现在多个分支下,而无需复制内容。
除了纯文本,它还支持哪些特殊的笔记类型?除了富文本所见即所得(WYSIWYG)编辑和带语法高亮的代码笔记外,还支持基于 Excalidraw 的画布绘图、Mind Elixir 思维导图、带 GPX 轨迹的地理地图、关系/链接图,以及可通过 REST API 实现自动化的可编程脚本笔记。
笔记数量非常多时,它的表现如何?README 中指出,在可用性和性能两方面,它都能很好地支持多达 10 万条笔记。
Size
676.3 MB
Stars
38.4K
Age
9y
Commits · 90 Days