机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

切线

这是 Tangent 项目的单一代码库。

Tangent 是一个本地笔记书写 / 个人知识管理工具。它深受 Obsidian 的启发，并发展出自己的方向。它使用 [[Wiki Links]] 以及略微自定义的 Markdown 语法。笔记在书写时完全呈现样式。Markdown 语法会隐藏，并在需要时显示。

其他主要功能：

• 创新的二维关联地图，用于导航和链接历史。
• “滑动面板”用户体验，灵感来自 Andy Matuschak 的笔记。
• 写作专注模式：突出显示当前段落、行或句子。
• 可自定义笔记视图：以卡片或无限动态加载的信息流形式查看你的笔记集合。
• 自定义 查询语言（带自动补全！）用于自定义复杂搜索。
• 支持嵌入图片、链接预览、PDF、音频和视频，包括 YouTube 链接！

预编译的二进制文件可在 下载页面 和 Flathub 找到。预发布版本也可在 Flathub Beta 获得。

模块

此仓库包含多个模块。

应用程序

apps 目录包含生成 Tangent 及其他 Tangent 相关可执行文件的模块。

• tangent-electron – 基于 Electron 的 Tangent 应用程序。
• tangent-website – tangentnotes.com 的源代码。
• tangent-test-workspace-generator – 一个用于生成测试内容的简单 CLI 工具。

包

packages 目录包含提供 Tangent 相关功能库的模块。

• tangent-html-to-markdown – 将 text/html 剪贴板数据转换为 Tangent 特定 Markdown 文本的解析器。
• tangent-query-parser – Tangent 查询语言的解析器。

库

lib 目录包含外部版本的库，这些库因各种原因已作为 git 子模块添加。

• typewriter – Typewriter 项目的 Tangent 特定分支。
• typewriter-document – Typewriter 的文档模型 的 Tangent 特定分支。

本地构建

1. 初始化并同步 git 子模块（例如 git submodule init 和 git submodule update）。
2. 在仓库根目录运行 npm ci 以安装整个单仓库中的所有依赖项。
3. 在仓库根目录运行 npm run build 以构建所有依赖项。
4. 在 ./apps/tangent-electron 中运行 npm run dev（或在 Windows 上运行 dev:win）以在开发模式下运行 tangent。

问题报告

在创建问题时，请确保为特定模块使用适当的标签。

在报告错误时，请包括：

1. 相关应用程序/软件包的版本。
2. 在问题标题中简明描述问题。
   • 例如，“点击‘新建笔记’按钮不会创建新的笔记”
3. 在问题正文中详细描述问题。
   • 导致问题所需的步骤。
     • 例如：
       1. “打开一个空白工作区”
       2. “点击新建笔记按钮”
       3. “注意没有创建新的笔记”
   • 包括任何可以帮助阐明问题的额外细节或背景信息。
4. 日志有时在查明问题时非常有帮助。
   • Tangent 的窗口内日志可以从开发者控制台找到。您可以在 Mac 上使用 Cmd+Option+I 打开它，或在 Windows 和 Linux 上使用 Ctrl+Shift+I 打开。附上截图或这些日志的内容可能会很有用。
   • Tangent 的应用程序日志可以在系统中的相关日志文件夹中找到。你可以从 Tangent 的命令面板（Cmd/Ctrl+P 打开面板）调用“显示日志”命令，以直接进入日志。