trilium/docs/README-ZH_CN.md

11 KiB
Vendored
Raw Permalink Blame History

Trilium Notes

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

英文 | 简体中文 | 正体中文 | 俄文 | 日文 | 意大利文 | 西班牙文

Trilium Notes 是一款免费且开源、跨平台的阶层式笔记应用程序,专注于建立大型个人知识库。

想快速了解,请查看屏幕截图

Trilium Screenshot

🎁 功能

想要更多 TriliumNext 的主题、脚本、外挂与资源,亦可参考以下第三方资源/社群:

⚠️ 为什么是 TriliumNext

原本的 Trilium 项目目前处于维护模式

从 Trilium 迁移?

从既有的 zadam/Trilium 例项迁移到 TriliumNext/Notes 不需要特别的迁移步骤。只要照一般方式安装 TriliumNext/Notes,它就会直接使用你现有的数据库。

版本至多至 v0.90.4 与 zadam/trilium 最新版本 v0.63.7 兼容。之后的 TriliumNext 版本已提升同步版本号(与上述不再兼容)。

📖 文件

我们目前正将文件搬移至应用程序内(在 Trilium 中按 F1)。在完成前,文件中可能会有缺漏。如果你想在 GitHub 上查看,也可以直接查看使用说明

以下提供一些快速连结,方便你导览文件:

在我们完成重新整理文件架构之前,你也可以查看旧版文件

💬 与我们交流

欢迎加入官方社群。我们很乐意听到你对功能、建议或问题的想法!

🏗 安装

Windows / macOS

最新释出页面下载你平台的二进制文件,解压缩后执行 trilium 可执行文件。

Linux

如果你的发行版如下表所列,请使用该发行版的套件。

Packaging status

你也可以从最新释出页面下载对应平台的二进制文件,解压缩后执行 trilium 可执行文件。

TriliumNext 也提供 Flatpak惟尚未发布到 FlatHub。

查看器(任何操作系统)

若你有(如下所述的)服务器安装,便可直接存取网页界面(其与桌面应用几乎相同)。

目前仅支持(并实测)最新版的 Chrome 与 Firefox。

移动装置

若要在行动装置上使用 TriliumNext你可以透过移动查看器存取服务器安装的移动版接口见下

如果你偏好原生 Android 应用,可使用 TriliumDroid。回报问题或缺少的功能,请至其储存库

更多关于移动应用支持的信息,请见议题:https://github.com/TriliumNext/Notes/issues/72

服务器

若要在你自己的服务器上安装 TriliumNext包括从 Docker Hub 使用 Docker 部署),请遵循服务器安装文件

💻 贡献

翻译

如果你是母语人士,欢迎前往我们的 Weblate 页面协助翻译 Trilium。

以下是目前的语言覆盖状态:

Translation status

程序代码

下载储存库,使用 pnpm 安装相依套件,接着启动服务器(于 http://localhost:8080 提供服务):

git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm run server:start

文件

下载储存库,使用 pnpm 安装相依套件,接着启动编辑文件所需的环境:

git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm nx run edit-docs:edit-docs

建置桌面可执行文件

下载储存库,使用 pnpm 安装相依套件,然后为 Windows 建置桌面应用:

git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm nx --project=desktop electron-forge:make -- --arch=x64 --platform=win32

更多细节请参见开发文件

开发者文件

请参阅环境设定指南。若有更多疑问,欢迎透过上方「与我们交流」章节所列连结与我们联系。

👏 鸣谢

  • CKEditor 5 —— 业界最佳的所见即所得编辑器,团队互动积极。
  • FancyTree —— 功能非常丰富的树状元件几乎没有对手。没有它Trilium Notes 将不会是今天的样子。
  • CodeMirror —— 支持大量语言的程序代码编辑器。
  • jsPlumb —— 无可匹敌的视觉联机函式库。用于关系图连结图

🤝 支持我们

目前尚无法直接赞助 TriliumNext 组织。不过你可以:

  • 透过赞助我们的开发者来支持 TriliumNext 的持续开发:eliandoran(完整清单请见 repository insights
  • 透过 PayPal 或比特币bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2向原始的 Trilium 开发者(zadam)表达支持。

🔑 授权条款

Copyright 20172025 zadam、Elian Doran 与其他贡献者。

本程序系自由软件你可以在自由软件基金会Free Software Foundation所发布的 GNU Affero 通用公众授权条款GNU AGPL第 3 版或(由你选择)任何后续版本之条款下重新散布或修改本程序。