|
1 | 1 | # Trilium Notes |
2 | 2 |
|
3 | | -[English](../README.md) | [Chinese](./README-ZH_CN.md) | [Russian](./README.ru.md) | [Japanese](./README.ja.md) | [Italian](./README.it.md) | [Spanish](./README.es.md) |
| 3 | +  |
| 4 | + |
| 5 | + |
| 6 | +[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp) [](https://hosted.weblate.org/engage/trilium/) |
4 | 7 |
|
5 | | -Trilium Notes 是一个层次化的笔记应用程序,专注于建立大型个人知识库。请参阅[屏幕截图](https://triliumnext.github.io/Docs/Wiki/screenshot-tour)以快速了解: |
| 8 | +[英文](../README.md) | [简体中文](./README-ZH_CN.md) | [正体中文](./README-ZH_TW.md) | [俄文](./README.ru.md) | [日文](./README.ja.md) | [意大利文](./README.it.md) | [西班牙文](./README.es.md) |
| 9 | + |
| 10 | +Trilium Notes 是一款免费且开源、跨平台的阶层式笔记应用程序,专注于建立大型个人知识库。 |
| 11 | + |
| 12 | +想快速了解,请查看[屏幕截图](https://triliumnext.github.io/Docs/Wiki/screenshot-tour): |
6 | 13 |
|
7 | 14 | <a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./app.png" alt="Trilium Screenshot" width="1000"></a> |
8 | 15 |
|
9 | | -## ⚠️ 为什么选择TriliumNext? |
| 16 | +## 🎁 功能 |
| 17 | + |
| 18 | +* 笔记可组织成任意深度的树形结构。单一笔记可放在树中的多个位置(参见[笔记复制/克隆](https://triliumnext.github.io/Docs/Wiki/cloning-notes))。 |
| 19 | +* 丰富的所见即所得(WYSIWYG)笔记编辑器,支持表格、图片与[数学公式](https://triliumnext.github.io/Docs/Wiki/text-notes),并具备 Markdown 的[自动格式](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat)。 |
| 20 | +* 支持编辑[程序代码笔记](https://triliumnext.github.io/Docs/Wiki/code-notes),包含语法高亮。 |
| 21 | +* 快速、轻松地在笔记间[导航](https://triliumnext.github.io/Docs/Wiki/note-navigation)、全文搜索,以及[笔记聚焦(hoisting)](https://triliumnext.github.io/Docs/Wiki/note-hoisting)。 |
| 22 | +* 无缝的[笔记版本管理](https://triliumnext.github.io/Docs/Wiki/note-revisions)。 |
| 23 | +* 笔记[属性](https://triliumnext.github.io/Docs/Wiki/attributes)可用于笔记的组织、查询与高级[脚本](https://triliumnext.github.io/Docs/Wiki/scripts)。 |
| 24 | +* 接口提供英文、德文、西班牙文、法文、罗马尼亚文与中文(简体与正体)。 |
| 25 | +* 直接整合 [OpenID 与 TOTP](./User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md) 以实现更安全的登录。 |
| 26 | +* 与自架的同步服务器进行[同步](https://triliumnext.github.io/Docs/Wiki/synchronization) |
| 27 | + * 另有[第三方同步服务器托管服务](https://trilium.cc/paid-hosting)。 |
| 28 | +* 将笔记[分享](https://triliumnext.github.io/Docs/Wiki/sharing)(公开发布)到互联网。 |
| 29 | +* 以每则笔记为粒度的强大[笔记加密](https://triliumnext.github.io/Docs/Wiki/protected-notes)。 |
| 30 | +* 手绘/示意图:基于 [Excalidraw](https://excalidraw.com/)(笔记类型为「canvas」)。 |
| 31 | +* 用于可视化笔记及其关系的[关系图](https://triliumnext.github.io/Docs/Wiki/relation-map)与[链接图](https://triliumnext.github.io/Docs/Wiki/link-map)。 |
| 32 | +* 思维导图:基于 [Mind Elixir](https://docs.mind-elixir.com/)。 |
| 33 | +* 具有定位钉与 GPX 轨迹的[地图](./User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md)。 |
| 34 | +* [脚本](https://triliumnext.github.io/Docs/Wiki/scripts)——参见[高级展示](https://triliumnext.github.io/Docs/Wiki/advanced-showcases)。 |
| 35 | +* 用于自动化的 [REST API](https://triliumnext.github.io/Docs/Wiki/etapi)。 |
| 36 | +* 在可用性与效能上均可良好扩展,支持超过 100,000 笔笔记。 |
| 37 | +* 为手机与平板优化的[移动前端](https://triliumnext.github.io/Docs/Wiki/mobile-frontend)。 |
| 38 | +* 内置[深色主题](https://triliumnext.github.io/Docs/Wiki/themes),并支持用户主题。 |
| 39 | +* [Evernote 导入](https://triliumnext.github.io/Docs/Wiki/evernote-import)与 [Markdown 导入与导出](https://triliumnext.github.io/Docs/Wiki/markdown)。 |
| 40 | +* 用于快速保存网页内容的 [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper)。 |
| 41 | +* 可自定义的 UI(侧边栏按钮、用户自定义小组件等)。 |
| 42 | +* [度量指标(Metrics)](./User%20Guide/User%20Guide/Advanced%20Usage/Metrics.md),并附有 [Grafana 仪表板](./User%20Guide/User%20Guide/Advanced%20Usage/Metrics/grafana-dashboard.json)。 |
| 43 | + |
| 44 | +✨ 想要更多 TriliumNext 的主题、脚本、外挂与资源,亦可参考以下第三方资源/社群: |
| 45 | + |
| 46 | +- [awesome-trilium](https://github.com/Nriver/awesome-trilium)(第三方主题、脚本、外挂与更多)。 |
| 47 | +- [TriliumRocks!](https://trilium.rocks/)(教学、指南等等)。 |
| 48 | + |
| 49 | +## ⚠️ 为什么是 TriliumNext? |
| 50 | + |
| 51 | +[原本的 Trilium 项目目前处于维护模式](https://github.com/zadam/trilium/issues/4620)。 |
| 52 | + |
| 53 | +### 从 Trilium 迁移? |
10 | 54 |
|
11 | | -[原始的Trilium项目目前处于维护模式](https://github.com/zadam/trilium/issues/4620) |
| 55 | +从既有的 zadam/Trilium 例项迁移到 TriliumNext/Notes 不需要特别的迁移步骤。只要[照一般方式安装 TriliumNext/Notes](#-安装),它就会直接使用你现有的数据库。 |
12 | 56 |
|
13 | | -## 🗭 与我们讨论 |
| 57 | +版本至多至 [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 版本已提升同步版本号(与上述不再兼容)。 |
14 | 58 |
|
15 | | -欢迎加入我们的官方讨论和社区。我们专注于Trilium的开发,乐于听取您对功能、建议或问题的意见! |
| 59 | +## 📖 文件 |
16 | 60 |
|
17 | | -- [Matrix](https://matrix.to/#/#triliumnext:matrix.org)(用于同步讨论) |
18 | | -- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions)(用于异步讨论) |
19 | | -- [Wiki](https://triliumnext.github.io/Docs/)(用于常见操作问题和用户指南) |
| 61 | +我们目前正将文件搬移至应用程序内(在 Trilium 中按 `F1`)。在完成前,文件中可能会有缺漏。如果你想在 GitHub 上查看,也可以直接查看[使用说明](./User%20Guide/User%20Guide/)。 |
20 | 62 |
|
21 | | -上面链接的两个房间是镜像的,所以您可以在任意平台上使用XMPP或者Matrix来和我们交流。 |
| 63 | +以下提供一些快速连结,方便你导览文件: |
| 64 | +- [服务器安装](./User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md) |
| 65 | + - [Docker 安装](./User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md) |
| 66 | +- [升级 TriliumNext](./User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md) |
| 67 | +- [基本概念与功能-笔记](./User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md) |
| 68 | +- [个人知识库的模式](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge) |
22 | 69 |
|
23 | | -### 非官方社区 |
| 70 | +在我们完成重新整理文件架构之前,你也可以[查看旧版文件](https://triliumnext.github.io/Docs)。 |
24 | 71 |
|
25 | | -[Trilium Rocks](https://discord.gg/aqdX9mXX4r) |
| 72 | +## 💬 与我们交流 |
26 | 73 |
|
27 | | -## 🎁 特性 |
| 74 | +欢迎加入官方社群。我们很乐意听到你对功能、建议或问题的想法! |
28 | 75 |
|
29 | | -* 笔记可以排列成任意深的树。单个笔记可以放在树中的多个位置(请参阅[克隆](https://triliumnext.github.io/Docs/Wiki/cloning-notes)) |
30 | | -* 丰富的所见即所得笔记编辑功能,包括带有 Markdown [自动格式化功能的](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat)表格,图像和[数学公式](https://triliumnext.github.io/Docs/Wiki/text-notes#math-support) |
31 | | -* 支持编辑[使用源代码的笔记](https://triliumnext.github.io/Docs/Wiki/code-notes),包括语法高亮显示 |
32 | | -* 笔记之间快速[导航](https://triliumnext.github.io/Docs/Wiki/note-navigation),全文搜索和[提升笔记](https://triliumnext.github.io/Docs/Wiki/note-hoisting) |
33 | | -* 无缝[笔记版本控制](https://triliumnext.github.io/Docs/Wiki/note-revisions) |
34 | | -* 笔记[属性](https://triliumnext.github.io/Docs/Wiki/attributes)可用于笔记组织,查询和高级[脚本编写](https://triliumnext.github.io/Docs/Wiki/scripts) |
35 | | -* [同步](https://triliumnext.github.io/Docs/Wiki/synchronization)与自托管同步服务器 |
36 | | - * 有一个[第三方提供的同步服务器托管服务](https://trilium.cc/paid-hosting) |
37 | | -* 公开地[分享](https://triliumnext.github.io/Docs/Wiki/sharing)(发布)笔记到互联网 |
38 | | -* 具有按笔记粒度的强大的[笔记加密](https://triliumnext.github.io/Docs/Wiki/protected-notes) |
39 | | -* 使用自带的 Excalidraw 来绘制图表(笔记类型“画布”) |
40 | | -* [关系图](https://triliumnext.github.io/Docs/Wiki/relation-map)和[链接图](https://triliumnext.github.io/Docs/Wiki/link-map),用于可视化笔记及其关系 |
41 | | -* [脚本](https://triliumnext.github.io/Docs/Wiki/scripts) - 请参阅[高级功能展示](https://triliumnext.github.io/Docs/Wiki/advanced-showcases) |
42 | | -* 可用于自动化的 [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) |
43 | | -* 在拥有超过 10 万条笔记时仍能保持良好的可用性和性能 |
44 | | -* 针对智能手机和平板电脑进行优化的[用于移动设备的前端](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) |
45 | | -* [夜间主题](https://triliumnext.github.io/Docs/Wiki/themes) |
46 | | -* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) 和 [Markdown 导入导出](https://triliumnext.github.io/Docs/Wiki/markdown)功能 |
47 | | -* 使用[网页剪藏](https://triliumnext.github.io/Docs/Wiki/web-clipper)轻松保存互联网上的内容 |
| 76 | +- [Matrix](https://matrix.to/#/#triliumnext:matrix.org)(同步讨论) |
| 77 | + - `General` Matrix 房间也桥接到 [XMPP ](xmpp:[email protected]?join) |
| 78 | +- [GitHub Discussions](https://github.com/TriliumNext/Notes/discussions)(异步讨论)。 |
| 79 | +- [GitHub Issues](https://github.com/TriliumNext/Notes/issues)(回报错误与提出功能需求)。 |
48 | 80 |
|
49 | | -✨ 查看以下第三方资源,获取更多关于TriliumNext的好东西: |
| 81 | +## 🏗 安装 |
50 | 82 |
|
51 | | -- [awesome-trilium](https://github.com/Nriver/awesome-trilium):提供第三方主题、脚本、插件等资源的列表。 |
52 | | -- [TriliumRocks!](https://trilium.rocks/):提供教程、指南等更多内容。 |
| 83 | +### Windows / macOS |
53 | 84 |
|
54 | | -## 🏗 构建 |
| 85 | +从[最新释出页面](https://github.com/TriliumNext/Trilium/releases/latest)下载你平台的二进制文件,解压缩后执行 `trilium` 可执行文件。 |
55 | 86 |
|
56 | | -Trilium 可以用作桌面应用程序(Linux 和 Windows)或服务器(Linux)上托管的 Web 应用程序。虽然有 macOS 版本的桌面应用程序,但它[不受支持](https://triliumnext.github.io/Docs/Wiki/faq#mac-os-support)。 |
| 87 | +### Linux |
57 | 88 |
|
58 | | -* 如果要在桌面上使用 Trilium,请从[最新版本](https://github.com/TriliumNext/Trilium/releases/latest)下载适用于您平台的二进制版本,解压缩该软件包并运行`trilium`可执行文件。 |
59 | | -* 如果要在服务器上安装 Trilium,请参考[此页面](https://triliumnext.github.io/Docs/Wiki/server-installation)。 |
60 | | - * 当前仅支持(测试过)最近发布的 Chrome 和 Firefox 浏览器。 |
| 89 | +如果你的发行版如下表所列,请使用该发行版的套件。 |
61 | 90 |
|
62 | | -Trilium 也提供 Flatpak: |
| 91 | +[](https://repology.org/project/triliumnext/versions) |
63 | 92 |
|
64 | | -[<img width="240" src="https://flathub.org/assets/badges/flathub-badge-en.png">](https://flathub.org/apps/details/com.github.zadam.trilium) |
| 93 | +你也可以从[最新释出页面](https://github.com/TriliumNext/Trilium/releases/latest)下载对应平台的二进制文件,解压缩后执行 `trilium` 可执行文件。 |
65 | 94 |
|
66 | | -## 📝 文档 |
| 95 | +TriliumNext 也提供 Flatpak,惟尚未发布到 FlatHub。 |
67 | 96 |
|
68 | | -[有关文档页面的完整列表,请参见 Wiki。](https://triliumnext.github.io/Docs/) |
| 97 | +### 查看器(任何操作系统) |
69 | 98 |
|
70 | | -* [Wiki 的中文翻译版本](https://github.com/baddate/trilium/wiki/) |
| 99 | +若你有(如下所述的)服务器安装,便可直接存取网页界面(其与桌面应用几乎相同)。 |
71 | 100 |
|
72 | | -您还可以阅读[个人知识库模式](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge),以获取有关如何使用 Trilium 的灵感。 |
| 101 | +目前仅支持(并实测)最新版的 Chrome 与 Firefox。 |
| 102 | + |
| 103 | +### 移动装置 |
| 104 | + |
| 105 | +若要在行动装置上使用 TriliumNext,你可以透过移动查看器存取服务器安装的移动版接口(见下)。 |
| 106 | + |
| 107 | +如果你偏好原生 Android 应用,可使用 [TriliumDroid](https://apt.izzysoft.de/fdroid/index/apk/eu.fliegendewurst.triliumdroid)。回报问题或缺少的功能,请至[其储存库](https://github.com/FliegendeWurst/TriliumDroid)。 |
| 108 | + |
| 109 | +更多关于移动应用支持的信息,请见议题:https://github.com/TriliumNext/Notes/issues/72。 |
| 110 | + |
| 111 | +### 服务器 |
| 112 | + |
| 113 | +若要在你自己的服务器上安装 TriliumNext(包括从 [Docker Hub](https://hub.docker.com/r/triliumnext/trilium) 使用 Docker 部署),请遵循[服务器安装文件](https://triliumnext.github.io/Docs/Wiki/server-installation)。 |
73 | 114 |
|
74 | 115 | ## 💻 贡献 |
75 | 116 |
|
| 117 | +### 翻译 |
| 118 | + |
| 119 | +如果你是母语人士,欢迎前往我们的 [Weblate 页面](https://hosted.weblate.org/engage/trilium/)协助翻译 Trilium。 |
76 | 120 |
|
77 | | -或者克隆本仓库到本地,并运行 |
| 121 | +以下是目前的语言覆盖状态: |
78 | 122 |
|
| 123 | +[](https://hosted.weblate.org/engage/trilium/) |
| 124 | + |
| 125 | +### 程序代码 |
| 126 | + |
| 127 | +下载储存库,使用 `pnpm` 安装相依套件,接着启动服务器(于 http://localhost:8080 提供服务): |
| 128 | +```shell |
| 129 | +git clone https://github.com/TriliumNext/Trilium.git |
| 130 | +cd Trilium |
| 131 | +pnpm install |
| 132 | +pnpm run server:start |
| 133 | +``` |
| 134 | + |
| 135 | +### 文件 |
| 136 | + |
| 137 | +下载储存库,使用 `pnpm` 安装相依套件,接着启动编辑文件所需的环境: |
| 138 | +```shell |
| 139 | +git clone https://github.com/TriliumNext/Trilium.git |
| 140 | +cd Trilium |
| 141 | +pnpm install |
| 142 | +pnpm nx run edit-docs:edit-docs |
| 143 | +``` |
| 144 | + |
| 145 | +### 建置桌面可执行文件 |
| 146 | + |
| 147 | +下载储存库,使用 `pnpm` 安装相依套件,然后为 Windows 建置桌面应用: |
79 | 148 | ```shell |
80 | | -npm install |
81 | | -npm run server:start |
| 149 | +git clone https://github.com/TriliumNext/Trilium.git |
| 150 | +cd Trilium |
| 151 | +pnpm install |
| 152 | +pnpm nx --project=desktop electron-forge:make -- --arch=x64 --platform=win32 |
82 | 153 | ``` |
83 | 154 |
|
84 | | -## 👏 致谢 |
| 155 | +更多细节请参见[开发文件](https://github.com/TriliumNext/Notes/blob/develop/docs/Developer%20Guide/Developer%20Guide/Building%20and%20deployment/Running%20a%20development%20build.md)。 |
| 156 | + |
| 157 | +### 开发者文件 |
| 158 | + |
| 159 | +请参阅[环境设定指南](./Developer%20Guide/Developer%20Guide/Environment%20Setup.md)。若有更多疑问,欢迎透过上方「与我们交流」章节所列连结与我们联系。 |
| 160 | + |
| 161 | +## 👏 鸣谢 |
| 162 | + |
| 163 | +* [CKEditor 5](https://github.com/ckeditor/ckeditor5) —— 业界最佳的所见即所得编辑器,团队互动积极。 |
| 164 | +* [FancyTree](https://github.com/mar10/fancytree) —— 功能非常丰富的树状元件,几乎没有对手。没有它,Trilium Notes 将不会是今天的样子。 |
| 165 | +* [CodeMirror](https://github.com/codemirror/CodeMirror) —— 支持大量语言的程序代码编辑器。 |
| 166 | +* [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)。 |
85 | 167 |
|
86 | | -* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - 市面上最好的所见即所得编辑器,拥有互动性强且聆听能力强的团队 |
87 | | -* [FancyTree](https://github.com/mar10/fancytree) - 一个非常丰富的关于树的库,强大到没有对手。没有它,Trilium Notes 将不会如此。 |
88 | | -* [CodeMirror](https://github.com/codemirror/CodeMirror) - 支持大量语言的代码编辑器 |
89 | | -* [jsPlumb](https://github.com/jsplumb/jsplumb) - 强大的可视化连接库。用于[关系图](https://triliumnext.github.io/Docs/Wiki/relation-map)和[链接图](https://triliumnext.github.io/Docs/Wiki/link-map) |
| 168 | +## 🤝 支持我们 |
90 | 169 |
|
91 | | -## 🤝 捐赠 |
| 170 | +目前尚无法直接赞助 TriliumNext 组织。不过你可以: |
| 171 | +- 透过赞助我们的开发者来支持 TriliumNext 的持续开发:[eliandoran](https://github.com/sponsors/eliandoran)(完整清单请见 [repository insights]([developers]([url](https://github.com/TriliumNext/Notes/graphs/contributors)))) |
| 172 | +- 透过 [PayPal](https://paypal.me/za4am) 或比特币(bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2)向原始的 Trilium 开发者([zadam](https://github.com/sponsors/zadam))表达支持。 |
92 | 173 |
|
93 | | -你可以通过 GitHub Sponsors,[PayPal](https://paypal.me/za4am) 或者比特币 (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2) 来捐赠。 |
| 174 | +## 🔑 授权条款 |
94 | 175 |
|
95 | | -## 🔑 许可证 |
| 176 | +Copyright 2017–2025 zadam、Elian Doran 与其他贡献者。 |
96 | 177 |
|
97 | | -本程序是自由软件:你可以再发布本软件和/或修改本软件,只要你遵循 Free Software Foundation 发布的 GNU Affero General Public License 的第三版或者任何(由你选择)更晚的版本。 |
| 178 | +本程序系自由软件:你可以在自由软件基金会(Free Software Foundation)所发布的 GNU Affero 通用公众授权条款(GNU AGPL)第 3 版或(由你选择)任何后续版本之条款下重新散布或修改本程序。 |
0 commit comments