Trilium Notes 开发者指南

Trilium Notes 开发者指南

trilium 新文档地址：https://github.com/baddate/trilium-wiki 项目地址: https://gitcode.com/gh_mirrors/tril/trilium

1. 项目目录结构及介绍

Trilium Notes 是一个层次化笔记应用，旨在构建大型个人知识库。以下是项目的目录结构及各部分的简要介绍：

• bin/: 存放一些可执行脚本。
• db/: 数据库相关文件，包括数据库迁移和初始化脚本。
• docs/: 项目文档，包括用户手册和开发文档。
• dump-db/: 数据库备份和恢复脚本。
• images/: 项目中使用的图像文件。
• libraries/: 项目依赖的第三方库。
• spec-es6/: ES6规范的测试文件。
• spec/: 通用测试文件。
• src/: 源代码目录，包含所有前端和后端的JavaScript代码。
• test-etapi/: 集成测试相关的代码。
• .github/: GitHub Actions 工作流和其他GitHub相关的配置文件。
• .husky/: Husky配置文件，用于Git钩子。
• .idea/: IntelliJ IDEA项目配置文件。
• .vscode/: Visual Studio Code项目配置文件。
• CODE_OF_CONDUCT: 项目行为准则。
• Dockerfile: Docker构建文件，用于创建容器镜像。
• LICENSE: 项目许可证文件。
• README.md: 项目自述文件。
• SECURITY.md: 安全策略文件。
• 其他配置和脚本文件。

2. 项目的启动文件介绍

项目的启动主要依赖于start-docker.sh脚本（如果是Docker环境）或者直接运行trilium可执行文件（如果是直接在本地运行）。

• start-docker.sh: 此脚本用于启动Docker容器，它将调用Docker命令来运行应用。确保你已经正确配置了Docker环境并且有权限执行该脚本。
• trilium: 直接在本地运行的可执行文件。在解压缩后的项目文件夹中，你可以直接运行此文件来启动Trilium Notes应用。

3. 项目的配置文件介绍

项目的主要配置文件是config-sample.ini，这是一个示例配置文件，你需要在实际部署时根据自己的需求进行相应的配置。

• config-sample.ini: 包含了应用运行所需要的基本配置，如数据库连接信息、应用的基本设置等。在部署应用之前，你需要根据实际情况修改此文件，并将其重命名为config.ini。

请确保正确配置了所有必要的设置，否则应用可能无法正确运行。在配置文件中，每一项设置都有详细的注释说明，以便于理解每个设置的作用。

trilium 新文档地址：https://github.com/baddate/trilium-wiki 项目地址: https://gitcode.com/gh_mirrors/tril/trilium