mirror of
https://github.com/zadam/trilium.git
synced 2025-10-31 02:16:05 +01:00
docs(readme): bring back original documents
This commit is contained in:
Elian Doran
178
docs/README-ZH_CN.md
vendored
Normal file
178
docs/README-ZH_CN.md
vendored
Normal file
@@ -0,0 +1,178 @@
|
|||||||
|
# Trilium Notes
|
||||||
|
|
||||||
|
 
|
||||||
|
|
||||||
|
|
||||||
|
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp) [](https://hosted.weblate.org/engage/trilium/)
|
||||||
|
|
||||||
|
[英文](../README.md) | [简体中文](./README-ZH_CN.md) | [正体中文](./README-ZH_TW.md) | [俄文](./README.ru.md) | [日文](./README.ja.md) | [意大利文](./README.it.md) | [西班牙文](./README.es.md)
|
||||||
|
|
||||||
|
Trilium Notes 是一款免费且开源、跨平台的阶层式笔记应用程序，专注于建立大型个人知识库。
|
||||||
|
|
||||||
|
想快速了解，请查看[屏幕截图](https://triliumnext.github.io/Docs/Wiki/screenshot-tour)：
|
||||||
|
|
||||||
|
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./app.png" alt="Trilium Screenshot" width="1000"></a>
|
||||||
|
|
||||||
|
## 🎁 功能
|
||||||
|
|
||||||
|
* 笔记可组织成任意深度的树形结构。单一笔记可放在树中的多个位置（参见[笔记复制/克隆](https://triliumnext.github.io/Docs/Wiki/cloning-notes)）。
|
||||||
|
* 丰富的所见即所得（WYSIWYG）笔记编辑器，支持表格、图片与[数学公式](https://triliumnext.github.io/Docs/Wiki/text-notes)，并具备 Markdown 的[自动格式](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat)。
|
||||||
|
* 支持编辑[程序代码笔记](https://triliumnext.github.io/Docs/Wiki/code-notes)，包含语法高亮。
|
||||||
|
* 快速、轻松地在笔记间[导航](https://triliumnext.github.io/Docs/Wiki/note-navigation)、全文搜索，以及[笔记聚焦（hoisting）](https://triliumnext.github.io/Docs/Wiki/note-hoisting)。
|
||||||
|
* 无缝的[笔记版本管理](https://triliumnext.github.io/Docs/Wiki/note-revisions)。
|
||||||
|
* 笔记[属性](https://triliumnext.github.io/Docs/Wiki/attributes)可用于笔记的组织、查询与高级[脚本](https://triliumnext.github.io/Docs/Wiki/scripts)。
|
||||||
|
* 接口提供英文、德文、西班牙文、法文、罗马尼亚文与中文（简体与正体）。
|
||||||
|
* 直接整合 [OpenID 与 TOTP](./User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md) 以实现更安全的登录。
|
||||||
|
* 与自架的同步服务器进行[同步](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
||||||
|
* 另有[第三方同步服务器托管服务](https://trilium.cc/paid-hosting)。
|
||||||
|
* 将笔记[分享](https://triliumnext.github.io/Docs/Wiki/sharing)（公开发布）到互联网。
|
||||||
|
* 以每则笔记为粒度的强大[笔记加密](https://triliumnext.github.io/Docs/Wiki/protected-notes)。
|
||||||
|
* 手绘/示意图：基于 [Excalidraw](https://excalidraw.com/)（笔记类型为「canvas」）。
|
||||||
|
* 用于可视化笔记及其关系的[关系图](https://triliumnext.github.io/Docs/Wiki/relation-map)与[链接图](https://triliumnext.github.io/Docs/Wiki/link-map)。
|
||||||
|
* 思维导图：基于 [Mind Elixir](https://docs.mind-elixir.com/)。
|
||||||
|
* 具有定位钉与 GPX 轨迹的[地图](./User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md)。
|
||||||
|
* [脚本](https://triliumnext.github.io/Docs/Wiki/scripts)——参见[高级展示](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)。
|
||||||
|
* 用于自动化的 [REST API](https://triliumnext.github.io/Docs/Wiki/etapi)。
|
||||||
|
* 在可用性与效能上均可良好扩展，支持超过 100,000 笔笔记。
|
||||||
|
* 为手机与平板优化的[移动前端](https://triliumnext.github.io/Docs/Wiki/mobile-frontend)。
|
||||||
|
* 内置[深色主题](https://triliumnext.github.io/Docs/Wiki/themes)，并支持用户主题。
|
||||||
|
* [Evernote 导入](https://triliumnext.github.io/Docs/Wiki/evernote-import)与 [Markdown 导入与导出](https://triliumnext.github.io/Docs/Wiki/markdown)。
|
||||||
|
* 用于快速保存网页内容的 [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper)。
|
||||||
|
* 可自定义的 UI（侧边栏按钮、用户自定义小组件等）。
|
||||||
|
* [度量指标（Metrics）](./User%20Guide/User%20Guide/Advanced%20Usage/Metrics.md)，并附有 [Grafana 仪表板](./User%20Guide/User%20Guide/Advanced%20Usage/Metrics/grafana-dashboard.json)。
|
||||||
|
|
||||||
|
✨ 想要更多 TriliumNext 的主题、脚本、外挂与资源，亦可参考以下第三方资源／社群：
|
||||||
|
|
||||||
|
- [awesome-trilium](https://github.com/Nriver/awesome-trilium)（第三方主题、脚本、外挂与更多）。
|
||||||
|
- [TriliumRocks!](https://trilium.rocks/)（教学、指南等等）。
|
||||||
|
|
||||||
|
## ⚠️ 为什么是 TriliumNext？
|
||||||
|
|
||||||
|
[原本的 Trilium 项目目前处于维护模式](https://github.com/zadam/trilium/issues/4620)。
|
||||||
|
|
||||||
|
### 从 Trilium 迁移？
|
||||||
|
|
||||||
|
从既有的 zadam/Trilium 例项迁移到 TriliumNext/Notes 不需要特别的迁移步骤。只要[照一般方式安装 TriliumNext/Notes](#-安装)，它就会直接使用你现有的数据库。
|
||||||
|
|
||||||
|
版本至多至 [v0.90.4](https://github.com/TriliumNext/Notes/releases/tag/v0.90.4) 与 zadam/trilium 最新版本 [v0.63.7](https://github.com/zadam/trilium/releases/tag/v0.63.7) 兼容。之后的 TriliumNext 版本已提升同步版本号（与上述不再兼容）。
|
||||||
|
|
||||||
|
## 📖 文件
|
||||||
|
|
||||||
|
我们目前正将文件搬移至应用程序内（在 Trilium 中按 `F1`）。在完成前，文件中可能会有缺漏。如果你想在 GitHub 上查看，也可以直接查看[使用说明](./User%20Guide/User%20Guide/)。
|
||||||
|
|
||||||
|
以下提供一些快速连结，方便你导览文件：
|
||||||
|
- [服务器安装](./User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
||||||
|
- [Docker 安装](./User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
||||||
|
- [升级 TriliumNext](./User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
||||||
|
- [基本概念与功能－笔记](./User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
||||||
|
- [个人知识库的模式](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
||||||
|
|
||||||
|
在我们完成重新整理文件架构之前，你也可以[查看旧版文件](https://triliumnext.github.io/Docs)。
|
||||||
|
|
||||||
|
## 💬 与我们交流
|
||||||
|
|
||||||
|
欢迎加入官方社群。我们很乐意听到你对功能、建议或问题的想法！
|
||||||
|
|
||||||
|
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org)（同步讨论）
|
||||||
|
- `General` Matrix 房间也桥接到 [XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
||||||
|
- [GitHub Discussions](https://github.com/TriliumNext/Notes/discussions)（异步讨论）。
|
||||||
|
- [GitHub Issues](https://github.com/TriliumNext/Notes/issues)（回报错误与提出功能需求）。
|
||||||
|
|
||||||
|
## 🏗 安装
|
||||||
|
|
||||||
|
### Windows / macOS
|
||||||
|
|
||||||
|
从[最新释出页面](https://github.com/TriliumNext/Trilium/releases/latest)下载你平台的二进制文件，解压缩后执行 `trilium` 可执行文件。
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
如果你的发行版如下表所列，请使用该发行版的套件。
|
||||||
|
|
||||||
|
[](https://repology.org/project/triliumnext/versions)
|
||||||
|
|
||||||
|
你也可以从[最新释出页面](https://github.com/TriliumNext/Trilium/releases/latest)下载对应平台的二进制文件，解压缩后执行 `trilium` 可执行文件。
|
||||||
|
|
||||||
|
TriliumNext 也提供 Flatpak，惟尚未发布到 FlatHub。
|
||||||
|
|
||||||
|
### 查看器（任何操作系统）
|
||||||
|
|
||||||
|
若你有（如下所述的）服务器安装，便可直接存取网页界面（其与桌面应用几乎相同）。
|
||||||
|
|
||||||
|
目前仅支持（并实测）最新版的 Chrome 与 Firefox。
|
||||||
|
|
||||||
|
### 移动装置
|
||||||
|
|
||||||
|
若要在行动装置上使用 TriliumNext，你可以透过移动查看器存取服务器安装的移动版接口（见下）。
|
||||||
|
|
||||||
|
如果你偏好原生 Android 应用，可使用 [TriliumDroid](https://apt.izzysoft.de/fdroid/index/apk/eu.fliegendewurst.triliumdroid)。回报问题或缺少的功能，请至[其储存库](https://github.com/FliegendeWurst/TriliumDroid)。
|
||||||
|
|
||||||
|
更多关于移动应用支持的信息，请见议题：https://github.com/TriliumNext/Notes/issues/72。
|
||||||
|
|
||||||
|
### 服务器
|
||||||
|
|
||||||
|
若要在你自己的服务器上安装 TriliumNext（包括从 [Docker Hub](https://hub.docker.com/r/triliumnext/trilium) 使用 Docker 部署），请遵循[服务器安装文件](https://triliumnext.github.io/Docs/Wiki/server-installation)。
|
||||||
|
|
||||||
|
## 💻 贡献
|
||||||
|
|
||||||
|
### 翻译
|
||||||
|
|
||||||
|
如果你是母语人士，欢迎前往我们的 [Weblate 页面](https://hosted.weblate.org/engage/trilium/)协助翻译 Trilium。
|
||||||
|
|
||||||
|
以下是目前的语言覆盖状态：
|
||||||
|
|
||||||
|
[](https://hosted.weblate.org/engage/trilium/)
|
||||||
|
|
||||||
|
### 程序代码
|
||||||
|
|
||||||
|
下载储存库，使用 `pnpm` 安装相依套件，接着启动服务器（于 http://localhost:8080 提供服务）：
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/TriliumNext/Trilium.git
|
||||||
|
cd Trilium
|
||||||
|
pnpm install
|
||||||
|
pnpm run server:start
|
||||||
|
```
|
||||||
|
|
||||||
|
### 文件
|
||||||
|
|
||||||
|
下载储存库，使用 `pnpm` 安装相依套件，接着启动编辑文件所需的环境：
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/TriliumNext/Trilium.git
|
||||||
|
cd Trilium
|
||||||
|
pnpm install
|
||||||
|
pnpm run edit-docs:edit-docs
|
||||||
|
```
|
||||||
|
|
||||||
|
### 建置桌面可执行文件
|
||||||
|
|
||||||
|
下载储存库，使用 `pnpm` 安装相依套件，然后为 Windows 建置桌面应用：
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/TriliumNext/Trilium.git
|
||||||
|
cd Trilium
|
||||||
|
pnpm install
|
||||||
|
pnpm --filter=desktop electron-forge:make --arch=x64 --platform=win32
|
||||||
|
```
|
||||||
|
|
||||||
|
更多细节请参见[开发文件](https://github.com/TriliumNext/Notes/blob/develop/docs/Developer%20Guide/Developer%20Guide/Building%20and%20deployment/Running%20a%20development%20build.md)。
|
||||||
|
|
||||||
|
### 开发者文件
|
||||||
|
|
||||||
|
请参阅[环境设定指南](./Developer%20Guide/Developer%20Guide/Environment%20Setup.md)。若有更多疑问，欢迎透过上方「与我们交流」章节所列连结与我们联系。
|
||||||
|
|
||||||
|
## 👏 鸣谢
|
||||||
|
|
||||||
|
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) —— 业界最佳的所见即所得编辑器，团队互动积极。
|
||||||
|
* [FancyTree](https://github.com/mar10/fancytree) —— 功能非常丰富的树状元件，几乎没有对手。没有它，Trilium Notes 将不会是今天的样子。
|
||||||
|
* [CodeMirror](https://github.com/codemirror/CodeMirror) —— 支持大量语言的程序代码编辑器。
|
||||||
|
* [jsPlumb](https://github.com/jsplumb/jsplumb) —— 无可匹敌的视觉联机函式库。用于[关系图](https://triliumnext.github.io/Docs/Wiki/relation-map.html)与[连结图](https://triliumnext.github.io/Docs/Wiki/note-map.html#link-map)。
|
||||||
|
|
||||||
|
## 🤝 支持我们
|
||||||
|
|
||||||
|
目前尚无法直接赞助 TriliumNext 组织。不过你可以：
|
||||||
|
- 透过赞助我们的开发者来支持 TriliumNext 的持续开发：[eliandoran](https://github.com/sponsors/eliandoran)（完整清单请见 [repository insights]([developers]([url](https://github.com/TriliumNext/Notes/graphs/contributors)))）
|
||||||
|
- 透过 [PayPal](https://paypal.me/za4am) 或比特币（bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2）向原始的 Trilium 开发者（[zadam](https://github.com/sponsors/zadam)）表达支持。
|
||||||
|
|
||||||
|
## 🔑 授权条款
|
||||||
|
|
||||||
|
Copyright 2017–2025 zadam、Elian Doran 与其他贡献者。
|
||||||
|
|
||||||
|
本程序系自由软件：你可以在自由软件基金会（Free Software Foundation）所发布的 GNU Affero 通用公众授权条款（GNU AGPL）第 3 版或（由你选择）任何后续版本之条款下重新散布或修改本程序。
|
||||||
178
docs/README-ZH_TW.md
vendored
Normal file
178
docs/README-ZH_TW.md
vendored
Normal file
@@ -0,0 +1,178 @@
|
|||||||
|
# Trilium Notes
|
||||||
|
|
||||||
|
 
|
||||||
|
|
||||||
|
|
||||||
|
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp) [](https://hosted.weblate.org/engage/trilium/)
|
||||||
|
|
||||||
|
[英文](../README.md) | [簡體中文](./README-ZH_CN.md) | [正體中文](./README-ZH_TW.md) | [俄文](./README.ru.md) | [日文](./README.ja.md) | [義大利文](./README.it.md) | [西班牙文](./README.es.md)
|
||||||
|
|
||||||
|
Trilium Notes 是一款免費且開源、跨平台的階層式筆記應用程式，專注於建立大型個人知識庫。
|
||||||
|
|
||||||
|
想快速了解，請查看[螢幕截圖](https://triliumnext.github.io/Docs/Wiki/screenshot-tour)：
|
||||||
|
|
||||||
|
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./app.png" alt="Trilium Screenshot" width="1000"></a>
|
||||||
|
|
||||||
|
## 🎁 功能
|
||||||
|
|
||||||
|
* 筆記可組織成任意深度的樹狀結構。單一筆記可放在樹中的多個位置（參見[筆記複製/克隆](https://triliumnext.github.io/Docs/Wiki/cloning-notes)）。
|
||||||
|
* 豐富的所見即所得（WYSIWYG）筆記編輯器，支援表格、圖片與[數學公式](https://triliumnext.github.io/Docs/Wiki/text-notes)，並具備 Markdown 的[自動格式化](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat)。
|
||||||
|
* 支援編輯[程式碼筆記](https://triliumnext.github.io/Docs/Wiki/code-notes)，包含語法高亮。
|
||||||
|
* 快速、輕鬆地在筆記間[導航](https://triliumnext.github.io/Docs/Wiki/note-navigation)、全文搜尋，以及[筆記聚焦（hoisting）](https://triliumnext.github.io/Docs/Wiki/note-hoisting)。
|
||||||
|
* 無縫的[筆記版本管理](https://triliumnext.github.io/Docs/Wiki/note-revisions)。
|
||||||
|
* 筆記[屬性](https://triliumnext.github.io/Docs/Wiki/attributes)可用於筆記的組織、查詢與進階[腳本](https://triliumnext.github.io/Docs/Wiki/scripts)。
|
||||||
|
* 介面提供英文、德文、西班牙文、法文、羅馬尼亞文與中文（簡體與正體）。
|
||||||
|
* 直接整合 [OpenID 與 TOTP](./User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md) 以實現更安全的登入。
|
||||||
|
* 與自架的同步伺服器進行[同步](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
||||||
|
* 另有[第三方同步伺服器託管服務](https://trilium.cc/paid-hosting)。
|
||||||
|
* 將筆記[分享](https://triliumnext.github.io/Docs/Wiki/sharing)（公開發布）到網際網路。
|
||||||
|
* 以每則筆記為粒度的強大[筆記加密](https://triliumnext.github.io/Docs/Wiki/protected-notes)。
|
||||||
|
* 手繪/示意圖：基於 [Excalidraw](https://excalidraw.com/)（筆記類型為「canvas」）。
|
||||||
|
* 用於視覺化筆記及其關係的[關聯圖](https://triliumnext.github.io/Docs/Wiki/relation-map)與[連結圖](https://triliumnext.github.io/Docs/Wiki/link-map)。
|
||||||
|
* 心智圖：基於 [Mind Elixir](https://docs.mind-elixir.com/)。
|
||||||
|
* 具有定位釘與 GPX 軌跡的[地圖](./User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md)。
|
||||||
|
* [腳本](https://triliumnext.github.io/Docs/Wiki/scripts)——參見[進階展示](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)。
|
||||||
|
* 用於自動化的 [REST API](https://triliumnext.github.io/Docs/Wiki/etapi)。
|
||||||
|
* 在可用性與效能上均可良好擴展，支援超過 100,000 筆筆記。
|
||||||
|
* 為手機與平板最佳化的[行動前端](https://triliumnext.github.io/Docs/Wiki/mobile-frontend)。
|
||||||
|
* 內建[深色主題](https://triliumnext.github.io/Docs/Wiki/themes)，並支援使用者主題。
|
||||||
|
* [Evernote 匯入](https://triliumnext.github.io/Docs/Wiki/evernote-import)與 [Markdown 匯入與匯出](https://triliumnext.github.io/Docs/Wiki/markdown)。
|
||||||
|
* 用於快速保存網頁內容的 [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper)。
|
||||||
|
* 可自訂的 UI（側邊欄按鈕、使用者自訂小工具等）。
|
||||||
|
* [度量指標（Metrics）](./User%20Guide/User%20Guide/Advanced%20Usage/Metrics.md)，並附有 [Grafana 儀表板](./User%20Guide/User%20Guide/Advanced%20Usage/Metrics/grafana-dashboard.json)。
|
||||||
|
|
||||||
|
✨ 想要更多 TriliumNext 的主題、腳本、外掛與資源，亦可參考以下第三方資源／社群：
|
||||||
|
|
||||||
|
- [awesome-trilium](https://github.com/Nriver/awesome-trilium)（第三方主題、腳本、外掛與更多）。
|
||||||
|
- [TriliumRocks!](https://trilium.rocks/)（教學、指南等等）。
|
||||||
|
|
||||||
|
## ⚠️ 為什麼是 TriliumNext？
|
||||||
|
|
||||||
|
[原本的 Trilium 專案目前處於維護模式](https://github.com/zadam/trilium/issues/4620)。
|
||||||
|
|
||||||
|
### 從 Trilium 遷移？
|
||||||
|
|
||||||
|
從既有的 zadam/Trilium 例項遷移到 TriliumNext/Notes 不需要特別的遷移步驟。只要[照一般方式安裝 TriliumNext/Notes](#-安裝)，它就會直接使用你現有的資料庫。
|
||||||
|
|
||||||
|
版本至多至 [v0.90.4](https://github.com/TriliumNext/Notes/releases/tag/v0.90.4) 與 zadam/trilium 最新版本 [v0.63.7](https://github.com/zadam/trilium/releases/tag/v0.63.7) 相容。之後的 TriliumNext 版本已提升同步版本號（與上述不再相容）。
|
||||||
|
|
||||||
|
## 📖 文件
|
||||||
|
|
||||||
|
我們目前正將文件搬移至應用程式內（在 Trilium 中按 `F1`）。在完成前，文件中可能會有缺漏。如果你想在 GitHub 上瀏覽，也可以直接查看[使用說明](./User%20Guide/User%20Guide/)。
|
||||||
|
|
||||||
|
以下提供一些快速連結，方便你導覽文件：
|
||||||
|
- [伺服器安裝](./User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
||||||
|
- [Docker 安裝](./User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
||||||
|
- [升級 TriliumNext](./User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
||||||
|
- [基本概念與功能－筆記](./User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
||||||
|
- [個人知識庫的模式](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
||||||
|
|
||||||
|
在我們完成重新整理文件架構之前，你也可以[瀏覽舊版文件](https://triliumnext.github.io/Docs)。
|
||||||
|
|
||||||
|
## 💬 與我們交流
|
||||||
|
|
||||||
|
歡迎加入官方社群。我們很樂意聽到你對功能、建議或問題的想法！
|
||||||
|
|
||||||
|
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org)（同步討論）
|
||||||
|
- `General` Matrix 房間也橋接到 [XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
||||||
|
- [GitHub Discussions](https://github.com/TriliumNext/Notes/discussions)（非同步討論）。
|
||||||
|
- [GitHub Issues](https://github.com/TriliumNext/Notes/issues)（回報錯誤與提出功能需求）。
|
||||||
|
|
||||||
|
## 🏗 安裝
|
||||||
|
|
||||||
|
### Windows / macOS
|
||||||
|
|
||||||
|
從[最新釋出頁面](https://github.com/TriliumNext/Trilium/releases/latest)下載你平台的二進位檔，解壓縮後執行 `trilium` 可執行檔。
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
如果你的發行版如下表所列，請使用該發行版的套件。
|
||||||
|
|
||||||
|
[](https://repology.org/project/triliumnext/versions)
|
||||||
|
|
||||||
|
你也可以從[最新釋出頁面](https://github.com/TriliumNext/Trilium/releases/latest)下載對應平台的二進位檔，解壓縮後執行 `trilium` 可執行檔。
|
||||||
|
|
||||||
|
TriliumNext 也提供 Flatpak，惟尚未發佈到 FlatHub。
|
||||||
|
|
||||||
|
### 瀏覽器（任何作業系統）
|
||||||
|
|
||||||
|
若你有（如下所述的）伺服器安裝，便可直接存取網頁介面（其與桌面應用幾乎相同）。
|
||||||
|
|
||||||
|
目前僅支援（並實測）最新版的 Chrome 與 Firefox。
|
||||||
|
|
||||||
|
### 行動裝置
|
||||||
|
|
||||||
|
若要在行動裝置上使用 TriliumNext，你可以透過行動瀏覽器存取伺服器安裝的行動版介面（見下）。
|
||||||
|
|
||||||
|
如果你偏好原生 Android 應用，可使用 [TriliumDroid](https://apt.izzysoft.de/fdroid/index/apk/eu.fliegendewurst.triliumdroid)。回報問題或缺少的功能，請至[其儲存庫](https://github.com/FliegendeWurst/TriliumDroid)。
|
||||||
|
|
||||||
|
更多關於行動應用支援的資訊，請見議題：https://github.com/TriliumNext/Notes/issues/72。
|
||||||
|
|
||||||
|
### 伺服器
|
||||||
|
|
||||||
|
若要在你自己的伺服器上安裝 TriliumNext（包括從 [Docker Hub](https://hub.docker.com/r/triliumnext/trilium) 使用 Docker 部署），請遵循[伺服器安裝文件](https://triliumnext.github.io/Docs/Wiki/server-installation)。
|
||||||
|
|
||||||
|
## 💻 貢獻
|
||||||
|
|
||||||
|
### 翻譯
|
||||||
|
|
||||||
|
如果你是母語人士，歡迎前往我們的 [Weblate 頁面](https://hosted.weblate.org/engage/trilium/)協助翻譯 Trilium。
|
||||||
|
|
||||||
|
以下是目前的語言覆蓋狀態：
|
||||||
|
|
||||||
|
[](https://hosted.weblate.org/engage/trilium/)
|
||||||
|
|
||||||
|
### 程式碼
|
||||||
|
|
||||||
|
下載儲存庫，使用 `pnpm` 安裝相依套件，接著啟動伺服器（將於 http://localhost:8080 提供服務）：
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/TriliumNext/Trilium.git
|
||||||
|
cd Trilium
|
||||||
|
pnpm install
|
||||||
|
pnpm run server:start
|
||||||
|
```
|
||||||
|
|
||||||
|
### 文件
|
||||||
|
|
||||||
|
下載儲存庫，使用 `pnpm` 安裝相依套件，接著啟動編輯文件所需的環境：
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/TriliumNext/Trilium.git
|
||||||
|
cd Trilium
|
||||||
|
pnpm install
|
||||||
|
pnpm edit-docs:edit-docs
|
||||||
|
```
|
||||||
|
|
||||||
|
### 建置桌面可執行檔
|
||||||
|
|
||||||
|
下載儲存庫，使用 `pnpm` 安裝相依套件，然後為 Windows 建置桌面應用：
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/TriliumNext/Trilium.git
|
||||||
|
cd Trilium
|
||||||
|
pnpm install
|
||||||
|
pnpm --filter=desktop electron-forge:make --arch=x64 --platform=win32
|
||||||
|
```
|
||||||
|
|
||||||
|
更多細節請參見[開發文件](https://github.com/TriliumNext/Notes/blob/develop/docs/Developer%20Guide/Developer%20Guide/Building%20and%20deployment/Running%20a%20development%20build.md)。
|
||||||
|
|
||||||
|
### 開發者文件
|
||||||
|
|
||||||
|
請參閱[環境設定指南](./Developer%20Guide/Developer%20Guide/Environment%20Setup.md)。若有更多疑問，歡迎透過上方「與我們交流」章節所列連結與我們聯繫。
|
||||||
|
|
||||||
|
## 👏 鳴謝
|
||||||
|
|
||||||
|
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) —— 業界最佳的所見即所得編輯器，團隊互動積極。
|
||||||
|
* [FancyTree](https://github.com/mar10/fancytree) —— 功能非常豐富的樹狀元件，幾乎沒有對手。沒有它，Trilium Notes 將不會是今天的樣子。
|
||||||
|
* [CodeMirror](https://github.com/codemirror/CodeMirror) —— 支援大量語言的程式碼編輯器。
|
||||||
|
* [jsPlumb](https://github.com/jsplumb/jsplumb) —— 無可匹敵的視覺連線函式庫。用於[關聯圖](https://triliumnext.github.io/Docs/Wiki/relation-map.html)與[連結圖](https://triliumnext.github.io/Docs/Wiki/note-map.html#link-map)。
|
||||||
|
|
||||||
|
## 🤝 支援我們
|
||||||
|
|
||||||
|
目前尚無法直接贊助 TriliumNext 組織。不過你可以：
|
||||||
|
- 透過贊助我們的開發者來支持 TriliumNext 的持續開發：[eliandoran](https://github.com/sponsors/eliandoran)（完整清單請見 [repository insights]([developers]([url](https://github.com/TriliumNext/Notes/graphs/contributors)))）
|
||||||
|
- 透過 [PayPal](https://paypal.me/za4am) 或比特幣（bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2）向原始的 Trilium 開發者（[zadam](https://github.com/sponsors/zadam)）表達支持。
|
||||||
|
|
||||||
|
## 🔑 授權條款
|
||||||
|
|
||||||
|
Copyright 2017–2025 zadam、Elian Doran 與其他貢獻者。
|
||||||
|
|
||||||
|
本程式係自由軟體：你可以在自由軟體基金會（Free Software Foundation）所發佈的 GNU Affero 通用公眾授權條款（GNU AGPL）第 3 版或（由你選擇）任何後續版本之條款下重新散布或修改本程式。
|
||||||
313
docs/README.ZH_CN.md
vendored
313
docs/README.ZH_CN.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.ZH_TW.md
vendored
313
docs/README.ZH_TW.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.ar.md
vendored
313
docs/README.ar.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.ca.md
vendored
313
docs/README.ca.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.cs.md
vendored
313
docs/README.cs.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.de.md
vendored
313
docs/README.de.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.el.md
vendored
313
docs/README.el.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
341
docs/README.es.md
vendored
341
docs/README.es.md
vendored
@@ -1,313 +1,106 @@
|
|||||||
# Trilium Notes
|
# Trilium Notes
|
||||||
|
|
||||||
|
[English](../README.md) | [Chinese](./README-ZH_CN.md) | [Russian](./README.ru.md) | [Japanese](./README.ja.md) | [Italian](./README.it.md) | [Spanish](./README.es.md)
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
Trilium Notes es una aplicación de toma de notas jerárquicas multi-plataforma y de código libre con un enfoque en la construcción de grandes bases de conocimiento personal.
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
Vea estas [capturas de pantalla](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) para un vistazo rápido:
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./app.png" alt="Trilium Screenshot" width="1000"></a>
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
## ⚠️ ¿Por qué usar TriliumNext?
|
||||||
|
|
||||||
## 📚 Documentation
|
[El proyecto Trilium original está en modo de mantenimiento](https://github.com/zadam/trilium/issues/4620)
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
### ¿Cómo migrar desde Trilium?
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
No hay pasos de migración especiales para migrar de una instancia de zadam/Trilium a una instancia de TriliumNext/Trilium. Simplemente actualice su instancia de Trilium a la última versión e [instale TriliumNext/Trilium como de costumbre](#-Instalación)
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
## 💬 Discuta con nosotros
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
Siéntase libre de unirse a nuestras conversaciones oficiales. ¡Nos encantaría escuchar de las características, sugerencias o problemas que pueda tener!
|
||||||
|
|
||||||
* Notes can be arranged into arbitrarily deep tree. Single note can be placed
|
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (Para discusiones síncronas)
|
||||||
into multiple places in the tree (see
|
- La sala `General` es replicada a [XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
||||||
[cloning](https://triliumnext.github.io/Docs/Wiki/cloning-notes))
|
- [Discusiones de GitHub](https://github.com/TriliumNext/Trilium/discussions) (Para discusiones asíncronas)
|
||||||
* Rich WYSIWYG note editor including e.g. tables, images and
|
- [Wiki](https://triliumnext.github.io/Docs/) (Para preguntas frecuentes y guías de usuario)
|
||||||
[math](https://triliumnext.github.io/Docs/Wiki/text-notes) with markdown
|
|
||||||
[autoformat](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
## 🎁 Características
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
- Las notas pueden ser acomodadas en un árbol de profundidad arbitraria. Una sola nota puede ser colocada en múltiples lugares del árbol (vea [clonar](https://triliumnext.github.io/Docs/Wiki/cloning-notes)
|
||||||
themes, scripts, plugins and more.
|
- Edición de notas WYSIWYG enriquecida que incluye, por ejemplo, tablas, imágenes y [matemáticas](https://triliumnext.github.io/Docs/Wiki/text-notes) con [autoformato](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat) markdown
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
- Soporte para editar [notas con código fuente](https://triliumnext.github.io/Docs/Wiki/code-notes), incluyendo resaltado de sintaxis
|
||||||
|
- Rápida y sencilla [navegación entre notas](https://triliumnext.github.io/Docs/Wiki/note-navigation), búsqueda de texto completo y [elevación de notas](https://triliumnext.github.io/Docs/Wiki/note-hoisting)
|
||||||
|
- [Versionado de notas](https://triliumnext.github.io/Docs/Wiki/note-revisions) sutil
|
||||||
|
- Los [atributos](https://triliumnext.github.io/Docs/Wiki/attributes) de las notas pueden utilizarse para organización, realizar consultas y [scripts](https://triliumnext.github.io/Docs/Wiki/scripts) avanzados
|
||||||
|
- [Sincronización](https://triliumnext.github.io/Docs/Wiki/synchronization) con servidor de sincronización propio
|
||||||
|
- existe un [servicio de terceros para alojar el servidor de sincronización](https://trilium.cc/paid-hosting)
|
||||||
|
- [Compartir](https://triliumnext.github.io/Docs/Wiki/sharing) (publicar) notas al Internet público
|
||||||
|
- Fuerte [encriptación de notas](https://triliumnext.github.io/Docs/Wiki/protected-notes) con granularidad para cada nota
|
||||||
|
- Esbozo de diagramas con Excalidraw incorporado (tipo de nota «canvas»)
|
||||||
|
- [Mapas de relaciones](<https://triliumnext.github.io/Docs/Wiki/relation-map>) y [mapas de enlaces](https://triliumnext.github.io/Docs/Wiki/link-map) para visualizar las notas y sus relaciones
|
||||||
|
- [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - vea [casos de uso avanzados](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
||||||
|
- [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) para automatización
|
||||||
|
- Escala bien tanto en uso como en rendimiento a partir de 100,000 notas
|
||||||
|
- [Interfaz móvil](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) optimizada para teléfonos inteligentes y tabletas
|
||||||
|
- [Tema nocturno](https://triliumnext.github.io/Docs/Wiki/themes)
|
||||||
|
- Importación y exportación de [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) y [Markdown](https://triliumnext.github.io/Docs/Wiki/markdown)
|
||||||
|
- [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) para guardar fácilmente contenido web
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
✨ Consulte los/las siguientes recursos/comunidades de terceros para obtener más información sobre complementos para TriliumNext:
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/zadam)) has
|
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) para temas, scripts, plugins y más de terceros.
|
||||||
graciously given the Trilium repository to the community project which resides
|
- [TriliumRocks!](https://trilium.rocks/) para tutoriales, guías y mucho más.
|
||||||
at https://github.com/TriliumNext
|
|
||||||
|
|
||||||
### ⬆️Migrating from Zadam/Trilium?
|
## 🏗 Instalación
|
||||||
|
|
||||||
There are no special migration steps to migrate from a zadam/Trilium instance to
|
### Escritorio
|
||||||
a TriliumNext/Trilium instance. Simply [install
|
|
||||||
TriliumNext/Trilium](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
Para usar TriliumNext en su máquina de escritorio (Linux, MacOS y Windows) tiene algunas opciones:
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/Trilium have their sync versions incremented which
|
|
||||||
prevents direct migration.
|
|
||||||
|
|
||||||
## 💬 Discuss with us
|
- Descargue la versión binaria para su plataforma desde la [página de lanzamientos](https://github.com/TriliumNext/Trilium/releases/latest), descomprima el paquete y ejecute el ejecutable `trilium`.
|
||||||
|
- Acceda a TriliumNext a través de la interfaz web de una instalación de servidor (ver más abajo)
|
||||||
|
- Actualmente solo las últimas versiones de Chrome y Firefox son compatibles (y están probadas).
|
||||||
|
- (Próximamente) TriliumNext también se proporcionará como un Flatpak
|
||||||
|
|
||||||
Feel free to join our official conversations. We would love to hear what
|
### Móvil
|
||||||
features, suggestions, or issues you may have!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
Para usar TriliumNext en un dispositivo móvil:
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
- Utilice un navegador web móvil para acceder a la interfaz móvil de una instalación de servidor (ver más abajo)
|
||||||
|
- El uso de una aplicación móvil aún no está soportado ([vea aquí](https://github.com/TriliumNext/Trilium/issues/72)) para seguir las mejoras móviles.
|
||||||
|
|
||||||
### Windows / MacOS
|
### Servidor
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
Para instalar TriliumNext en su servidor (incluyendo vía Docker desde [Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) siga la [documentación de instalación de servidor](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
## 📝 Documentación
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
[Vea la Wiki para la lista completa de páginas de documentación.](https://triliumnext.github.io/Docs)
|
||||||
package.
|
|
||||||
|
|
||||||
[ para obtener un poco de inspiración de como podría usar TriliumNext.
|
||||||
status](https://repology.org/badge/vertical-allrepos/triliumnext.svg)](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
## 💻 Contribuir
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the
|
|
||||||
package and run the `trilium` executable.
|
|
||||||
|
|
||||||
TriliumNext is also provided as a Flatpak, but not yet published on FlatHub.
|
Clone localmente y ejecute
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
npm install
|
||||||
cd Trilium
|
npm run server:start
|
||||||
pnpm install
|
|
||||||
pnpm run server:start
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Documentation
|
## 👏 Reconocimientos
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
- [CKEditor 5](https://github.com/ckeditor/ckeditor5) - el mejor editor WYSIWYG en el mercado, equipo muy interactivo y atento
|
||||||
environment required to edit the documentation:
|
- [FancyTree](https://github.com/mar10/fancytree) - biblioteca de árbol muy rica en funciones sin competencia real. Trilium Notes no sería lo mismo sin esta.
|
||||||
```shell
|
- [CodeMirror](https://github.com/codemirror/CodeMirror) - editor de código con soporte para una gran cantidad de lenguajes
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
- [jsPlumb](https://github.com/jsplumb/jsplumb) - biblioteca de conectividad visual sin competencia. Usado en [mapas de relación](https://triliumnext.github.io/Docs/Wiki/Relation-map) y [mapas de enlace](https://triliumnext.github.io/Docs/Wiki/Link-map)
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
## 🤝 Soporte
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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
|
Puede apoyar al desarrollador original de Trilium usando GitHub Sponsors, [PayPal](https://paypal.me/za4am) o Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2).
|
||||||
docs](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
Apoyo para la organización TriliumNext será posible en un futuro próximo.
|
||||||
|
|
||||||
### Developer Documentation
|
## 🔑 Licencia
|
||||||
|
|
||||||
Please view the [documentation
|
Este programa es software libre: puede redistribuirlo y/o modificarlo bajo los términos de la Licencia Pública General de Affero GNU publicada por la Free Software Foundation, ya sea la versión 3 de la Licencia, o (a su elección) cualquier versión posterior.
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
|
|||||||
313
docs/README.fa.md
vendored
313
docs/README.fa.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.fi.md
vendored
313
docs/README.fi.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.fr.md
vendored
313
docs/README.fr.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.hr.md
vendored
313
docs/README.hr.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.hu.md
vendored
313
docs/README.hu.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
348
docs/README.it.md
vendored
348
docs/README.it.md
vendored
@@ -1,313 +1,93 @@
|
|||||||
# Trilium Notes
|
# Trilium Notes
|
||||||
|
|
||||||
|
[English](../README.md) | [Chinese](./README-ZH_CN.md) | [Russian](./README.ru.md) | [Japanese](./README.ja.md) | [Italian](./README.it.md) | [Spanish](./README.es.md)
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
Trilium Notes è un'applicazione per appunti ad organizzazione gerarchica, studiata per la costruzione di archivi di conoscenza personali di grandi dimensioni.
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
Vedi [fotografie](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) per una panoramica veloce:
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./app.png" alt="Trilium Screenshot" width="1000"></a>
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
## ⚠️ Perchè TriliumNext?
|
||||||
|
[Il progetto originale Trilium è in modalità di manutenzione](https://github.com/zadam/trilium/issues/4620)
|
||||||
|
|
||||||
## 📚 Documentation
|
## 🗭 Discuti con noi
|
||||||
|
Sentiti libero di unirti alle nostre discussioni ufficiali e alla nostra comunità. Siamo concentrati sullo sviluppo di Trilium e ci piacerebbe sapere quali funzioni, suggerimenti o eventuali problemi hai!
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (Per discussioni sincrone)
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
- [Discussioni Github](https://github.com/TriliumNext/Trilium/discussions) (Per discussioni asincrone)
|
||||||
|
- [Wiki](https://triliumnext.github.io/Docs/) (Per le domande più comuni e le guide per l'utente)
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
Le due stanze linkate sopra sono connesse e contengono gli stessi messaggi, quindi puoi usare XMPP o Matrix da qualsiasi client tu preferisca, praticamente su qualsiasi piattaforma!
|
||||||
- **Online Documentation**: Browse the full documentation at
|
### Comunità non ufficiali
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
[Trilium Rocks](https://discord.gg/aqdX9mXX4r)
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
## 🎁 Funzionalità
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
* Gli appunti possono essere organizzati in un albero di profondità arbitraria. Un singolo appunto può essere collocato in più posti nell'albero (vedi [clonazione](https://triliumnext.github.io/Docs/Wiki/cloning-notes))
|
||||||
|
* Ricco editor visuale (WYSIWYG), con supporto -tra l'altro- per tabelle, immagini ed [espressioni matematiche](https://triliumnext.github.io/Docs/Wiki/text-notes#math-support) e con [formattazione automatica](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat) per markdown
|
||||||
|
* Supporto per la modifica di [appunti con codice sorgente](https://triliumnext.github.io/Docs/Wiki/code-notes), con evidenziazione della sintassi
|
||||||
|
* [Navigazione veloce](https://triliumnext.github.io/Docs/Wiki/note-navigation) tra gli appunti, ricerca testuale completa e [fissaggio degli appunti](https://triliumnext.github.io/Docs/Wiki/note-hoisting)
|
||||||
|
* Supporto integrato ed automatico per le [revisioni degli appunti](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
||||||
|
* Gli [attributi](https://triliumnext.github.io/Docs/Wiki/attributes) degli appunti possono essere utilizzati per l'organizzazione, per l'interrogazione e per lo scripting avanzato (prorgrammazione).
|
||||||
|
* [Sincronizzazione](https://triliumnext.github.io/Docs/Wiki/synchronization) con un server di sincronizzazione auto-ospitato
|
||||||
|
* c'è un [servizio di terze parti per ospitare server di sincronizzazione](https://trilium.cc/paid-hosting)
|
||||||
|
* [Condivisione](https://triliumnext.github.io/Docs/Wiki/sharing) (pubblicazione) di appunti sull'internet pubblico
|
||||||
|
* Robusta [crittografia](https://triliumnext.github.io/Docs/Wiki/protected-notes) configurabile singolarmente per ogni appunto
|
||||||
|
* Disegno di diagrammi con Excalidraw (tipo di appunto "canvas")
|
||||||
|
* [Mappe relazionali](https://triliumnext.github.io/Docs/Wiki/relation-map) e [mappe di collegamenti](https://triliumnext.github.io/Docs/Wiki/link-map) per visualizzare gli appunti e le loro relazioni
|
||||||
|
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - vedi [Esempi avanzati](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
||||||
|
* [API REST](https://triliumnext.github.io/Docs/Wiki/etapi) per l'automazione
|
||||||
|
* Si adatta bene sia in termini di usabilità che di prestazioni fino ad oltre 100 000 appunti
|
||||||
|
* Interfaccia utente ottimizzata per il [mobile](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) (smartphone e tablet)
|
||||||
|
* [Tema Notturno](https://triliumnext.github.io/Docs/Wiki/themes)
|
||||||
|
* Supporto per importazione ed esportazione da e per [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) e [Markdown import](https://triliumnext.github.io/Docs/Wiki/markdown)
|
||||||
|
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) per il salvataggio facile di contenuti web
|
||||||
|
|
||||||
* Notes can be arranged into arbitrarily deep tree. Single note can be placed
|
✨ Dai un'occhiata alle seguenti risorse di terze parti per scoprire altre bellezze legate a TriliumNext:
|
||||||
into multiple places in the tree (see
|
|
||||||
[cloning](https://triliumnext.github.io/Docs/Wiki/cloning-notes))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
-[awesome-trilium](https://github.com/Nriver/awesome-trilium) per temi, script, plugin e altro di terze parti.
|
||||||
related goodies:
|
- [TriliumRocks!](https://trilium.rocks/) per tutorial, guide e molto altro.
|
||||||
|
## 🏗 Rilasci
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
Trilium è fornito come applicazione desktop (Linux e Windows) o come applicazione web ospitata sul tuo server (Linux). La versione desktop per Mac OS è disponibile, ma [non è supportata](https://triliumnext.github.io/Docs/Wiki/faq#mac-os-support).
|
||||||
|
|
||||||
### Translations
|
* Se vuoi usare Trilium sul tuo desktop, scarica il rilascio binario per la tua piattaforma dall'[ultimo rilascio](https://github.com/TriliumNext/Trilium/releases/latest), decomprimi l'archivio e avvia l'eseguibile ```trilium```.
|
||||||
|
* Se vuoi installare Trilium su un server, segui [questa pagina](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
||||||
|
* Per ora solo Chrome e Firefox sono i browser supportati (testati).
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
TriliumNext sarà fornito anche come Flatpak:
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
<img width="240" src="https://flathub.org/assets/badges/flathub-badge-en.png">
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
[Vedi la wiki per una lista completa delle pagine di documentazione.](https://triliumnext.github.io/Docs/)
|
||||||
|
|
||||||
|
Puoi anche leggere ["Patterns of personal knowledge base"](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge) per avere un'ispirazione su come potresti utilizzare Trilium.
|
||||||
|
|
||||||
|
## 💻 Contribuire
|
||||||
|
|
||||||
|
Clona localmente ed esegui
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
npm install
|
||||||
cd Trilium
|
npm run server:start
|
||||||
pnpm install
|
|
||||||
pnpm run server:start
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Documentation
|
## 👏 Riconoscimenti
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - miglior editor visuale (WYSIWYG) sul mercato, squadra di sviluppo attenta e reattiva
|
||||||
environment required to edit the documentation:
|
* [FancyTree](https://github.com/mar10/fancytree) - libreria per alberi molto ricca di funzionalità, senza pari. Trilium Notes non sarebbe lo stesso senza di essa.
|
||||||
```shell
|
* [CodeMirror](https://github.com/codemirror/CodeMirror) - editor di codice con supporto per un'enorme quantità di linguaggi.
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
* [jsPlumb](https://github.com/jsplumb/jsplumb) - libreria per la connettività visuale senza pari. Utilizzata per [mappe relazionali](https://triliumnext.github.io/Docs/Wiki/relation-map) e [mappe di collegamenti](https://triliumnext.github.io/Docs/Wiki/link-map).
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
## 🤝 Supporto
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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
|
Puoi sostenere lo sviluppatore originale di Trilium utilizzando gli sponsor di GitHub, [PayPal](https://paypal.me/za4am) o Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2).
|
||||||
docs](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
Il supporto all'organizzazione TriliumNext sarà possibile nel prossimo futuro.
|
||||||
|
|
||||||
### Developer Documentation
|
## 🔑 Licenza
|
||||||
|
|
||||||
Please view the [documentation
|
Questo programma è software libero: è possibile redistribuirlo e/o modificarlo nei termini della GNU Affero General Public License come pubblicata dalla Free Software Foundation, sia la versione 3 della Licenza, o (a propria scelta) qualsiasi versione successiva.
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
|
|||||||
334
docs/README.ja.md
vendored
334
docs/README.ja.md
vendored
@@ -1,313 +1,73 @@
|
|||||||
# Trilium Notes
|
# Trilium Notes
|
||||||
|
|
||||||
|
[English](../README.md) | [Chinese](./README-ZH_CN.md) | [Russian](./README.ru.md) | [Japanese](./README.ja.md) | [Italian](./README.it.md) | [Spanish](./README.es.md)
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
Trilium Notes は、大規模な個人知識ベースの構築に焦点を当てた、階層型ノートアプリケーションです。概要は[スクリーンショット](https://triliumnext.github.io/Docs/Wiki/screenshot-tour)をご覧ください：
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./app.png" alt="Trilium Screenshot" width="1000"></a>
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
## 🎁 特徴
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
* ノートは、任意の深さのツリーに配置できます。単一のノートをツリー内の複数の場所に配置できます ([cloning](https://triliumnext.github.io/Docs/Wiki/cloning-notes) を参照)
|
||||||
|
* マークダウン[オートフォーマット](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat)による、表、画像、[数学](https://triliumnext.github.io/Docs/Wiki/text-notes#math-support)などの豊富な WYSIWYG ノート編集機能
|
||||||
|
* シンタックスハイライトを含む[ソースコード付きノート](https://triliumnext.github.io/Docs/Wiki/code-notes)の編集をサポート
|
||||||
|
* [ノート間のナビゲーション](https://triliumnext.github.io/Docs/Wiki/note-navigation)、全文検索、[ノートホイスト](https://triliumnext.github.io/Docs/Wiki/note-hoisting)が高速かつ簡単に行えます
|
||||||
|
* シームレスな[ノートのバージョン管理](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
||||||
|
* ノート[属性](https://triliumnext.github.io/Docs/Wiki/Attributes)は、ノート整理、クエリ、高度な[スクリプト](https://triliumnext.github.io/Docs/Wiki/scripts)に使用できます
|
||||||
|
* 自己ホスト型同期サーバーとの[同期](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
||||||
|
* [同期サーバーをホストするサードパーティ・サービス](https://trilium.cc/paid-hosting)があります
|
||||||
|
* 公開インターネットへのノートの[共有](https://triliumnext.github.io/Docs/Wiki/sharing)(公開)
|
||||||
|
* ノートごとの粒度を持つ強力な[ノート暗号化](https://triliumnext.github.io/Docs/Wiki/protected-notes)
|
||||||
|
* 組み込みの Excalidraw を使用した図のスケッチ (ノート タイプ"キャンバス")
|
||||||
|
* ノートとその関係を可視化するための[関係図](https://triliumnext.github.io/Docs/Wiki/relation-map)と[リンクマップ](https://triliumnext.github.io/Docs/Wiki/link-map)
|
||||||
|
* [スクリプティング](https://triliumnext.github.io/Docs/Wiki/scripts) - [高度なショーケース](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)を参照
|
||||||
|
* 自動化のための [REST API](https://triliumnext.github.io/Docs/Wiki/etapi)
|
||||||
|
* ユーザビリティとパフォーマンスの両方で 100 000 ノート以上に拡張可能
|
||||||
|
* スマートフォンとタブレット向けのタッチ最適化[モバイルフロントエンド](https://triliumnext.github.io/Docs/Wiki/mobile-frontend)
|
||||||
|
* [ナイトテーマ](https://triliumnext.github.io/Docs/Wiki/themes)
|
||||||
|
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) と [Markdown のインポートとエクスポート](https://triliumnext.github.io/Docs/Wiki/Markdown)
|
||||||
|
* Web コンテンツを簡単に保存するための [Web クリッパー](https://triliumnext.github.io/Docs/Wiki/web-clipper)
|
||||||
|
|
||||||
## 📚 Documentation
|
サードパーティのテーマ、スクリプト、プラグインなどは、 [awesome-trilium](https://github.com/Nriver/awesome-trilium) をチェックしてください。
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
## 🏗 ビルド
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
Trilium は、デスクトップアプリケーション（Linux、Windows）またはサーバー上でホストされるウェブアプリケーション（Linux）として提供されます。 Mac OS のデスクトップビルドも利用可能ですが、 [unsupported](https://triliumnext.github.io/Docs/Wiki/faq#mac-os-support) となっています。
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
* デスクトップで Trilium を使用したい場合は、 [latest release](https://github.com/TriliumNext/Trilium/releases/latest) からお使いのプラットフォームのバイナリリリースをダウンロードし、パッケージを解凍して ``trilium`` の実行ファイルを実行してください。
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
* サーバーに Trilium をインストールする場合は、[このページ](https://triliumnext.github.io/Docs/Wiki/server-installation)に従ってください。
|
||||||
- [Installation
|
* 現在、対応（動作確認）しているブラウザは、最近の Chrome と Firefox のみです。
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
Trilium は Flatpak としても提供されます：
|
||||||
|
|
||||||
* Notes can be arranged into arbitrarily deep tree. Single note can be placed
|
[<img width="240" src="https://flathub.org/assets/badges/flathub-badge-en.png">](https://flathub.org/apps/details/com.github.zadam.trilium)
|
||||||
into multiple places in the tree (see
|
|
||||||
[cloning](https://triliumnext.github.io/Docs/Wiki/cloning-notes))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
## 📝 ドキュメント
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
[ドキュメントページの全リストはwikiをご覧ください。](https://triliumnext.github.io/Docs/)
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
また、[個人的な知識基盤のパターン](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)を読むと、 Trilium の使い方のヒントを得ることができます。
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
npm install
|
||||||
cd Trilium
|
npm run server:start
|
||||||
pnpm install
|
|
||||||
pnpm run server:start
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Documentation
|
## 📢 シャウトアウト
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - 市場で最高の WYSIWYG エディター、非常にインタラクティブで聞き上手なチーム
|
||||||
environment required to edit the documentation:
|
* [FancyTree](https://github.com/mar10/fancytree) - 真の競争相手がいない、非常に機能豊富なツリーライブラリです。 Trilium Notes は、これなしでは成り立たないでしょう。
|
||||||
```shell
|
* [CodeMirror](https://github.com/codemirror/CodeMirror) - 膨大な数の言語をサポートするコードエディタ
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
* [jsPlumb](https://github.com/jsplumb/jsplumb) - 競合のないビジュアルコネクティビティライブラリです。[関係図](https://triliumnext.github.io/Docs/Wiki/relation-map)、[リンク図](https://triliumnext.github.io/Docs/Wiki/link-map)で使用。
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
## 🤝 サポート
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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
|
GitHub スポンサー、[PayPal](https://paypal.me/za4am)もしくは Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2) にて Trilium をサポートすることができます。
|
||||||
docs](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
## 🔑 ライセンス
|
||||||
|
|
||||||
Please view the [documentation
|
このプログラムはフリーソフトウェアです：フリーソフトウェア財団が発行した GNU Affero General Public License のバージョン3、またはそれ以降のバージョンのいずれかに従って、再配布および/または改変することができます。
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
|
|||||||
313
docs/README.ko.md
vendored
313
docs/README.ko.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
4
docs/README.md
vendored
4
docs/README.md
vendored
@@ -6,7 +6,7 @@ Please see the [main documentation](index.md) or visit one of our translated ver
|
|||||||
- [Italiano](README.it.md)
|
- [Italiano](README.it.md)
|
||||||
- [日本語](README.ja.md)
|
- [日本語](README.ja.md)
|
||||||
- [Русский](README.ru.md)
|
- [Русский](README.ru.md)
|
||||||
- [简体中文](README.ZH_CN.md)
|
- [简体中文](README-ZH_CN.md)
|
||||||
- [繁體中文](README.ZH_TW.md)
|
- [繁體中文](README-ZH_TW.md)
|
||||||
|
|
||||||
For the full application README, please visit our [GitHub repository](https://github.com/triliumnext/trilium).
|
For the full application README, please visit our [GitHub repository](https://github.com/triliumnext/trilium).
|
||||||
313
docs/README.nb_NO.md
vendored
313
docs/README.nb_NO.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.nl.md
vendored
313
docs/README.nl.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.pl.md
vendored
313
docs/README.pl.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.pt.md
vendored
313
docs/README.pt.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.pt_BR.md
vendored
313
docs/README.pt_BR.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
330
docs/README.ru.md
vendored
330
docs/README.ru.md
vendored
@@ -1,313 +1,59 @@
|
|||||||
# Trilium Notes
|
# Trilium Notes
|
||||||
|
|
||||||
|
[English](../README.md) | [Chinese](./README-ZH_CN.md) | [Russian](./README.ru.md) | [Japanese](./README.ja.md) | [Italian](./README.it.md) | [Spanish](./README.es.md)
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
Trilium Notes – это приложение для заметок с иерархической структурой, ориентированное на создание больших персональных баз знаний. Для быстрого ознакомления посмотрите [скриншот-тур](https://triliumnext.github.io/Docs/Wiki/screenshot-tour):
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./app.png" alt="Trilium Screenshot" width="1000"></a>
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
## 🎁 Возможности
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
* Заметки можно расположить в виде дерева произвольной глубины. Отдельную заметку можно разместить в нескольких местах дерева (см. [клонирование](https://triliumnext.github.io/Docs/Wiki/cloning-notes))
|
||||||
|
* Продвинутый визуальный редактор (WYSIWYG) позволяет работать с таблицами, изображениями, [формулами](https://triliumnext.github.io/Docs/Wiki/text-notes#math-support) и разметкой markdown, имеет [автоформатирование](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat)
|
||||||
|
* Редактирование [заметок с исходным кодом](https://triliumnext.github.io/Docs/Wiki/code-notes), включая подсветку синтаксиса
|
||||||
|
* Быстрая и простая [навигация между заметками](https://triliumnext.github.io/Docs/Wiki/note-navigation), полнотекстовый поиск и [выделение заметок](https://triliumnext.github.io/Docs/Wiki/note-hoisting) в отдельный блок
|
||||||
|
* Бесшовное [версионирование заметки](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
||||||
|
* Специальные [атрибуты](https://triliumnext.github.io/Docs/Wiki/attributes) позволяют гибко организовать структуру, используются для поиска и продвинутого [скриптинга](https://triliumnext.github.io/Docs/Wiki/scripts)
|
||||||
|
* [Синхронизация](https://triliumnext.github.io/Docs/Wiki/synchronization) заметок со своим сервером
|
||||||
|
* Надёжное [шифрование](https://triliumnext.github.io/Docs/Wiki/protected-notes) с детализацией по каждой заметке
|
||||||
|
* [Карты связей](https://triliumnext.github.io/Docs/Wiki/relation-map) и [карты ссылок](https://triliumnext.github.io/Docs/Wiki/link-map) для визуализации их взяимосвязей
|
||||||
|
* [Скрипты](https://triliumnext.github.io/Docs/Wiki/scripts) - см. [продвинутые примеры](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
||||||
|
* Хорошо масштабируется, как по удобству использования, так и по производительности до 100000 заметок
|
||||||
|
* Оптимизированный [мобильный фронтенд](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) смартфонов и планшетов
|
||||||
|
* [Темная тема](https://triliumnext.github.io/Docs/Wiki/themes)
|
||||||
|
* Импорт и экпорт [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) и данных в [markdown](https://triliumnext.github.io/Docs/Wiki/markdown) формате
|
||||||
|
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) для удобного сохранения веб-контента
|
||||||
|
|
||||||
## 📚 Documentation
|
## 🏗 Сборки
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
Trilium предоставляется в виде десктопного приложения (Linux и Windows) или веб-приложения, размещенного на вашем сервере (Linux). Доступна сборка Mac OS, но она [не поддерживается](https://triliumnext.github.io/Docs/Wiki/faq#mac-os-support).
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
* Если вы хотите использовать Trilium на десктопе, скачайте архив для своей платформы со страницы [релизов](https://github.com/TriliumNext/Trilium/releases/latest), распакуйте и запустите исполняемый файл ```trilium```.
|
||||||
- **Online Documentation**: Browse the full documentation at
|
* Если вы хотите установить Trilium на сервере, следуйте этой [инструкции](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
* В данный момент поддерживаются (протестированы) последние версии браузеров Chrome и Firefox.
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
## 📝 Документация
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
[Полный список страниц документации доступен в Wiki.](https://triliumnext.github.io/Docs/)
|
||||||
|
|
||||||
* Notes can be arranged into arbitrarily deep tree. Single note can be placed
|
Вы также можете ознакомиться с [шаблонами персональных баз знаний](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge), чтобы получить представление о том, как можно использовать Trilium.
|
||||||
into multiple places in the tree (see
|
|
||||||
[cloning](https://triliumnext.github.io/Docs/Wiki/cloning-notes))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
## 💻 Участвуйте в разработке
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
Или склонируйте на своё устройство и запустите
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
npm install
|
||||||
cd Trilium
|
npm run server:start
|
||||||
pnpm install
|
|
||||||
pnpm run server:start
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Documentation
|
## 👏 Благодарности
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - лучший WYSIWYG редактор, очень активная и внимательная команда.
|
||||||
environment required to edit the documentation:
|
* [FancyTree](https://github.com/mar10/fancytree) - многофункциональная библиотека для создания древовидных структур. Вне конкуренции. Без него Trilium Notes не были бы таким.
|
||||||
```shell
|
* [CodeMirror](https://github.com/codemirror/CodeMirror) - редактор кода с поддержкой огромного количество языков.
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
* [jsPlumb](https://github.com/jsplumb/jsplumb) - библиотека для визуализации связей. Вне конкуренции. Используется в [картах связей](https://triliumnext.github.io/Docs/Wiki/relation-map) и [картах ссылок](https://triliumnext.github.io/Docs/Wiki/link-map).
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
## 🔑 Лицензия
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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
|
Эта программа является бесплатным программным обеспечением: вы можете распространять и/или изменять ее в соответствии с условиями GNU Affero General Public License, опубликованной Free Software Foundation, либо версии 3 Лицензии, либо (по вашему выбору) любой более поздней версии.
|
||||||
docs](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
|
|||||||
313
docs/README.sl.md
vendored
313
docs/README.sl.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.sr.md
vendored
313
docs/README.sr.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.tr.md
vendored
313
docs/README.tr.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.uk.md
vendored
313
docs/README.uk.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
313
docs/README.vi.md
vendored
313
docs/README.vi.md
vendored
@@ -1,313 +0,0 @@
|
|||||||
# Trilium Notes
|
|
||||||
|
|
||||||
|
|
||||||
\
|
|
||||||
|
|
||||||
\
|
|
||||||
[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) |
|
|
||||||
[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README.ru.md)
|
|
||||||
| [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) |
|
|
||||||
[Spanish](./docs/README.es.md)
|
|
||||||
|
|
||||||
Trilium Notes is a free and open-source, cross-platform hierarchical note taking
|
|
||||||
application with focus on building large personal knowledge bases.
|
|
||||||
|
|
||||||
See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for
|
|
||||||
quick overview:
|
|
||||||
|
|
||||||
<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a>
|
|
||||||
|
|
||||||
## 📚 Documentation
|
|
||||||
|
|
||||||
**Visit our comprehensive documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
|
|
||||||
|
|
||||||
Our documentation is available in multiple formats:
|
|
||||||
- **Online Documentation**: Browse the full documentation at
|
|
||||||
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
|
|
||||||
- **In-App Help**: Press `F1` within Trilium to access the same documentation
|
|
||||||
directly in the application
|
|
||||||
- **GitHub**: Navigate through the [User
|
|
||||||
Guide](./docs/User%20Guide/User%20Guide/) in this repository
|
|
||||||
|
|
||||||
### Quick Links
|
|
||||||
- [Getting Started Guide](https://docs.triliumnotes.org/)
|
|
||||||
- [Installation
|
|
||||||
Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
|
|
||||||
- [Docker
|
|
||||||
Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
|
|
||||||
- [Upgrading
|
|
||||||
TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
|
|
||||||
- [Basic Concepts and
|
|
||||||
Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
|
|
||||||
- [Patterns of Personal Knowledge
|
|
||||||
Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge)
|
|
||||||
|
|
||||||
## 🎁 Features
|
|
||||||
|
|
||||||
* 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))
|
|
||||||
* 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)
|
|
||||||
* Support for editing [notes with source
|
|
||||||
code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax
|
|
||||||
highlighting
|
|
||||||
* 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)
|
|
||||||
* Seamless [note
|
|
||||||
versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
|
|
||||||
* 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)
|
|
||||||
* UI available in English, German, Spanish, French, Romanian, and Chinese
|
|
||||||
(simplified and traditional)
|
|
||||||
* Direct [OpenID and TOTP
|
|
||||||
integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md)
|
|
||||||
for more secure login
|
|
||||||
* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization)
|
|
||||||
with self-hosted sync server
|
|
||||||
* there's a [3rd party service for hosting synchronisation
|
|
||||||
server](https://trilium.cc/paid-hosting)
|
|
||||||
* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes
|
|
||||||
to public internet
|
|
||||||
* Strong [note
|
|
||||||
encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with
|
|
||||||
per-note granularity
|
|
||||||
* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type
|
|
||||||
"canvas")
|
|
||||||
* [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
|
|
||||||
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
|
|
||||||
* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with
|
|
||||||
location pins and GPX tracks
|
|
||||||
* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced
|
|
||||||
showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)
|
|
||||||
* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation
|
|
||||||
* Scales well in both usability and performance upwards of 100 000 notes
|
|
||||||
* Touch optimized [mobile
|
|
||||||
frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for
|
|
||||||
smartphones and tablets
|
|
||||||
* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support
|
|
||||||
for user themes
|
|
||||||
* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and
|
|
||||||
[Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown)
|
|
||||||
* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy
|
|
||||||
saving of web content
|
|
||||||
* Customizable UI (sidebar buttons, user-defined widgets, ...)
|
|
||||||
* [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)
|
|
||||||
|
|
||||||
✨ Check out the following third-party resources/communities for more TriliumNext
|
|
||||||
related goodies:
|
|
||||||
|
|
||||||
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party
|
|
||||||
themes, scripts, plugins and more.
|
|
||||||
- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more.
|
|
||||||
|
|
||||||
## ❓Why TriliumNext?
|
|
||||||
|
|
||||||
The original Trilium developer ([Zadam](https://github.com/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](#-installation) as usual and it will use your existing
|
|
||||||
database.
|
|
||||||
|
|
||||||
Versions up to and including
|
|
||||||
[v0.90.4](https://github.com/TriliumNext/Trilium/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/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!
|
|
||||||
|
|
||||||
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous
|
|
||||||
discussions.)
|
|
||||||
- The `General` Matrix room is also bridged to
|
|
||||||
[XMPP](xmpp:discuss@trilium.thisgreat.party?join)
|
|
||||||
- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For
|
|
||||||
asynchronous discussions.)
|
|
||||||
- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug
|
|
||||||
reports and feature requests.)
|
|
||||||
|
|
||||||
## 🏗 Installation
|
|
||||||
|
|
||||||
### Windows / MacOS
|
|
||||||
|
|
||||||
Download the binary release for your platform from the [latest release
|
|
||||||
page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package
|
|
||||||
and run the `trilium` executable.
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
If your distribution is listed in the table below, use your distribution's
|
|
||||||
package.
|
|
||||||
|
|
||||||
[](https://repology.org/project/triliumnext/versions)
|
|
||||||
|
|
||||||
You may also download the binary release for your platform from the [latest
|
|
||||||
release page](https://github.com/TriliumNext/Trilium/releases/latest), 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.
|
|
||||||
|
|
||||||
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). 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.
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
To install TriliumNext on your own server (including via Docker from
|
|
||||||
[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server
|
|
||||||
installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation).
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 Contribute
|
|
||||||
|
|
||||||
### Translations
|
|
||||||
|
|
||||||
If you are a native speaker, help us translate Trilium by heading over to our
|
|
||||||
[Weblate page](https://hosted.weblate.org/engage/trilium/).
|
|
||||||
|
|
||||||
Here's the language coverage we have so far:
|
|
||||||
|
|
||||||
[](https://hosted.weblate.org/engage/trilium/)
|
|
||||||
|
|
||||||
### Code
|
|
||||||
|
|
||||||
Download the repository, install dependencies using `pnpm` and then run the
|
|
||||||
server (available at http://localhost:8080):
|
|
||||||
```shell
|
|
||||||
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:
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/TriliumNext/Trilium.git
|
|
||||||
cd Trilium
|
|
||||||
pnpm install
|
|
||||||
pnpm edit-docs:edit-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Executable
|
|
||||||
Download the repository, install dependencies using `pnpm` and then build the
|
|
||||||
desktop app for Windows:
|
|
||||||
```shell
|
|
||||||
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](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide).
|
|
||||||
|
|
||||||
### Developer Documentation
|
|
||||||
|
|
||||||
Please view the [documentation
|
|
||||||
guide](https://github.com/TriliumNext/Trilium/blob/main/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.
|
|
||||||
|
|
||||||
## 👏 Shoutouts
|
|
||||||
|
|
||||||
* [zadam](https://github.com/zadam) for the original concept and implementation
|
|
||||||
of the application.
|
|
||||||
* [Larsa](https://github.com/LarsaSara) for designing the application icon.
|
|
||||||
* [nriver](https://github.com/nriver) for his work on internationalization.
|
|
||||||
* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas.
|
|
||||||
* [antoniotejada](https://github.com/nriver) for the original syntax highlight
|
|
||||||
widget.
|
|
||||||
* [Dosu](https://dosu.dev/) for providing us with the automated responses to
|
|
||||||
GitHub issues and discussions.
|
|
||||||
* [Tabler Icons](https://tabler.io/icons) for the system tray icons.
|
|
||||||
|
|
||||||
Trilium would not be possible without the technologies behind it:
|
|
||||||
|
|
||||||
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind
|
|
||||||
text notes. We are grateful for being offered a set of the premium features.
|
|
||||||
* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with
|
|
||||||
support for huge amount of languages.
|
|
||||||
* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite
|
|
||||||
whiteboard used in Canvas notes.
|
|
||||||
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the
|
|
||||||
mind map functionality.
|
|
||||||
* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical
|
|
||||||
maps.
|
|
||||||
* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive
|
|
||||||
table used in collections.
|
|
||||||
* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library
|
|
||||||
without real competition.
|
|
||||||
* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library.
|
|
||||||
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)
|
|
||||||
|
|
||||||
## 🤝 Support
|
|
||||||
|
|
||||||
Trilium is built and maintained with [hundreds of hours of
|
|
||||||
work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your
|
|
||||||
support keeps it open-source, improves features, and covers costs such as
|
|
||||||
hosting.
|
|
||||||
|
|
||||||
Consider supporting the main developer
|
|
||||||
([eliandoran](https://github.com/eliandoran)) of the application via:
|
|
||||||
|
|
||||||
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
|
|
||||||
- [PayPal](https://paypal.me/eliandoran)
|
|
||||||
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
|
|
||||||
|
|
||||||
## 🔑 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.
|
|
||||||
Reference in New Issue
Block a user