diff --git a/README.md b/README.md index 0b66ccb87..183ab1452 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/triliumnext/notes/total) [![RelativeCI](https://badges.relative-ci.com/badges/Di5q7dz9daNDZ9UXi0Bp?branch=develop)](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp) [![Translation status](https://hosted.weblate.org/widget/trilium/svg-badge.svg)](https://hosted.weblate.org/engage/trilium/) -[English](./README.md) | [Chinese](./docs/README-ZH_CN.md) | [Russian](./docs/README.ru.md) | [Japanese](./docs/README.ja.md) | [Italian](./docs/README.it.md) | [Spanish](./docs/README.es.md) +[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. @@ -110,7 +110,7 @@ See issue https://github.com/TriliumNext/Notes/issues/72 for more information on ### Server -To install TriliumNext on your own server (including via Docker from [Dockerhub](https://hub.docker.com/r/triliumnext/notes)) follow [the server installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation). +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 diff --git a/docs/README-ZH_CN.md b/docs/README-ZH_CN.md index 39ef00b40..a23a24acd 100644 --- a/docs/README-ZH_CN.md +++ b/docs/README-ZH_CN.md @@ -1,97 +1,178 @@ # 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) +![GitHub Sponsors](https://img.shields.io/github/sponsors/eliandoran) ![LiberaPay patrons](https://img.shields.io/liberapay/patrons/ElianDoran) +![Docker Pulls](https://img.shields.io/docker/pulls/triliumnext/notes) +![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/triliumnext/notes/total) +[![RelativeCI](https://badges.relative-ci.com/badges/Di5q7dz9daNDZ9UXi0Bp?branch=develop)](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp) [![Translation status](https://hosted.weblate.org/widget/trilium/svg-badge.svg)](https://hosted.weblate.org/engage/trilium/) -Trilium Notes 是一个层次化的笔记应用程序,专注于建立大型个人知识库。请参阅[屏幕截图](https://triliumnext.github.io/Docs/Wiki/screenshot-tour)以快速了解: +[英文](../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): Trilium Screenshot -## ⚠️ 为什么选择TriliumNext? +## 🎁 功能 -[原始的Trilium项目目前处于维护模式](https://github.com/zadam/trilium/issues/4620) +* 笔记可组织成任意深度的树形结构。单一笔记可放在树中的多个位置(参见[笔记复制/克隆](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 的主题、脚本、外挂与资源,亦可参考以下第三方资源/社群: -欢迎加入我们的官方讨论和社区。我们专注于Trilium的开发,乐于听取您对功能、建议或问题的意见! +- [awesome-trilium](https://github.com/Nriver/awesome-trilium)(第三方主题、脚本、外挂与更多)。 +- [TriliumRocks!](https://trilium.rocks/)(教学、指南等等)。 -- [Matrix](https://matrix.to/#/#triliumnext:matrix.org)(用于同步讨论) -- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions)(用于异步讨论) -- [Wiki](https://triliumnext.github.io/Docs/)(用于常见操作问题和用户指南) +## ⚠️ 为什么是 TriliumNext? -上面链接的两个房间是镜像的,所以您可以在任意平台上使用XMPP或者Matrix来和我们交流。 +[原本的 Trilium 项目目前处于维护模式](https://github.com/zadam/trilium/issues/4620)。 -### 非官方社区 +### 从 Trilium 迁移? -[Trilium Rocks](https://discord.gg/aqdX9mXX4r) +从既有的 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 版本已提升同步版本号(与上述不再兼容)。 -* 笔记可以排列成任意深的树。单个笔记可以放在树中的多个位置(请参阅[克隆](https://triliumnext.github.io/Docs/Wiki/cloning-notes)) -* 丰富的所见即所得笔记编辑功能,包括带有 Markdown [自动格式化功能的](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat)表格,图像和[数学公式](https://triliumnext.github.io/Docs/Wiki/text-notes#math-support) -* 支持编辑[使用源代码的笔记](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) -* 在拥有超过 10 万条笔记时仍能保持良好的可用性和性能 -* 针对智能手机和平板电脑进行优化的[用于移动设备的前端](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)功能 -* 使用[网页剪藏](https://triliumnext.github.io/Docs/Wiki/web-clipper)轻松保存互联网上的内容 +## 📖 文件 -✨ 查看以下第三方资源,获取更多关于TriliumNext的好东西: +我们目前正将文件搬移至应用程序内(在 Trilium 中按 `F1`)。在完成前,文件中可能会有缺漏。如果你想在 GitHub 上查看,也可以直接查看[使用说明](./User%20Guide/User%20Guide/)。 -- [awesome-trilium](https://github.com/Nriver/awesome-trilium):提供第三方主题、脚本、插件等资源的列表。 -- [TriliumRocks!](https://trilium.rocks/):提供教程、指南等更多内容。 +以下提供一些快速连结,方便你导览文件: +- [服务器安装](./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)。 -Trilium 可以用作桌面应用程序(Linux 和 Windows)或服务器(Linux)上托管的 Web 应用程序。虽然有 macOS 版本的桌面应用程序,但它[不受支持](https://triliumnext.github.io/Docs/Wiki/faq#mac-os-support)。 +## 💬 与我们交流 -* 如果要在桌面上使用 Trilium,请从[最新版本](https://github.com/TriliumNext/Trilium/releases/latest)下载适用于您平台的二进制版本,解压缩该软件包并运行`trilium`可执行文件。 -* 如果要在服务器上安装 Trilium,请参考[此页面](https://triliumnext.github.io/Docs/Wiki/server-installation)。 - * 当前仅支持(测试过)最近发布的 Chrome 和 Firefox 浏览器。 +欢迎加入官方社群。我们很乐意听到你对功能、建议或问题的想法! -Trilium 也提供 Flatpak: +- [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)(回报错误与提出功能需求)。 -[](https://flathub.org/apps/details/com.github.zadam.trilium) +## 🏗 安装 -## 📝 文档 +### Windows / macOS -[有关文档页面的完整列表,请参见 Wiki。](https://triliumnext.github.io/Docs/) +从[最新释出页面](https://github.com/TriliumNext/Trilium/releases/latest)下载你平台的二进制文件,解压缩后执行 `trilium` 可执行文件。 -* [Wiki 的中文翻译版本](https://github.com/baddate/trilium/wiki/) +### Linux -您还可以阅读[个人知识库模式](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge),以获取有关如何使用 Trilium 的灵感。 +如果你的发行版如下表所列,请使用该发行版的套件。 + +[![Packaging status](https://repology.org/badge/vertical-allrepos/triliumnext.svg)](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。 +以下是目前的语言覆盖状态: + +[![Translation status](https://hosted.weblate.org/widget/trilium/multi-auto.svg)](https://hosted.weblate.org/engage/trilium/) + +### 程序代码 + +下载储存库,使用 `pnpm` 安装相依套件,接着启动服务器(于 http://localhost:8080 提供服务): ```shell -npm install -npm run server:start +git clone https://github.com/TriliumNext/Trilium.git +cd Trilium +pnpm install +pnpm run server:start ``` -## 👏 致谢 +### 文件 -* [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)和[链接图](https://triliumnext.github.io/Docs/Wiki/link-map) +下载储存库,使用 `pnpm` 安装相依套件,接着启动编辑文件所需的环境: +```shell +git clone https://github.com/TriliumNext/Trilium.git +cd Trilium +pnpm install +pnpm nx run edit-docs:edit-docs +``` -## 🤝 捐赠 +### 建置桌面可执行文件 -你可以通过 GitHub Sponsors,[PayPal](https://paypal.me/za4am) 或者比特币 (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2) 来捐赠。 +下载储存库,使用 `pnpm` 安装相依套件,然后为 Windows 建置桌面应用: +```shell +git clone https://github.com/TriliumNext/Trilium.git +cd Trilium +pnpm install +pnpm nx --project=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)。 -本程序是自由软件:你可以再发布本软件和/或修改本软件,只要你遵循 Free Software Foundation 发布的 GNU Affero General Public License 的第三版或者任何(由你选择)更晚的版本。 +### 开发者文件 + +请参阅[环境设定指南](./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 版或(由你选择)任何后续版本之条款下重新散布或修改本程序。 diff --git a/docs/README-ZH_TW.md b/docs/README-ZH_TW.md new file mode 100644 index 000000000..d471bfce3 --- /dev/null +++ b/docs/README-ZH_TW.md @@ -0,0 +1,178 @@ +# Trilium Notes + +![GitHub Sponsors](https://img.shields.io/github/sponsors/eliandoran) ![LiberaPay patrons](https://img.shields.io/liberapay/patrons/ElianDoran) +![Docker Pulls](https://img.shields.io/docker/pulls/triliumnext/notes) +![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/triliumnext/notes/total) +[![RelativeCI](https://badges.relative-ci.com/badges/Di5q7dz9daNDZ9UXi0Bp?branch=develop)](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp) [![Translation status](https://hosted.weblate.org/widget/trilium/svg-badge.svg)](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): + +Trilium Screenshot + +## 🎁 功能 + +* 筆記可組織成任意深度的樹狀結構。單一筆記可放在樹中的多個位置(參見[筆記複製/克隆](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 + +如果你的發行版如下表所列,請使用該發行版的套件。 + +[![Packaging status](https://repology.org/badge/vertical-allrepos/triliumnext.svg)](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。 + +以下是目前的語言覆蓋狀態: + +[![Translation status](https://hosted.weblate.org/widget/trilium/multi-auto.svg)](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 nx run edit-docs:edit-docs +``` + +### 建置桌面可執行檔 + +下載儲存庫,使用 `pnpm` 安裝相依套件,然後為 Windows 建置桌面應用: +```shell +git clone https://github.com/TriliumNext/Trilium.git +cd Trilium +pnpm install +pnpm nx --project=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 版或(由你選擇)任何後續版本之條款下重新散布或修改本程式。