Obsidian Todoist 插件技术文档

Obsidian Todoist 插件技术文档

obsidian-todoist-plugin Materialize Todoist tasks in Obsidian notes 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-todoist-plugin

1. 安装指南

1.1 前提条件

在安装 Obsidian Todoist 插件之前，请确保您已经安装并配置好以下软件：

• Obsidian: 确保您已经安装并配置好 Obsidian 笔记应用。
• Todoist: 确保您已经注册并登录 Todoist 账户。

1.2 安装步骤

1. 打开 Obsidian: 启动您的 Obsidian 应用。
2. 进入社区插件市场: 在 Obsidian 中，点击左侧边栏的“设置”图标，然后选择“社区插件”。
3. 搜索插件: 在搜索框中输入“Todoist”，找到“Sync with Todoist Plugin”插件。
4. 安装插件: 点击“安装”按钮，等待安装完成。
5. 启用插件: 安装完成后，点击“启用”按钮，启用插件。

2. 项目使用说明

2.1 配置插件

1. 获取 API 密钥: 登录您的 Todoist 账户，进入设置页面，找到并复制您的 API 密钥。
2. 配置插件: 在 Obsidian 中，进入插件设置页面，粘贴您的 Todoist API 密钥，并保存设置。

2.2 同步任务

1. 创建任务: 在 Obsidian 中创建新笔记，并在笔记中使用特定的语法（如 - [ ] 任务名称）创建任务。
2. 同步任务: 插件会自动将您在 Obsidian 中创建的任务同步到 Todoist，并在 Todoist 中完成的任务同步回 Obsidian。

2.3 查看任务

1. 查看同步任务: 在 Obsidian 中，您可以在笔记中查看同步的任务，并根据任务状态（如已完成或未完成）进行标记。
2. 查看 Todoist 任务: 您也可以在 Todoist 应用中查看和管理同步的任务。

3. 项目 API 使用文档

3.1 API 密钥获取

1. 登录 Todoist: 访问 Todoist 官网 并登录您的账户。
2. 进入设置: 点击右上角的头像，选择“设置”。
3. 获取 API 密钥: 在设置页面中，找到“API 密钥”部分，复制您的 API 密钥。

3.2 API 使用

1. 配置 API 密钥: 在 Obsidian 插件设置中，粘贴您从 Todoist 获取的 API 密钥。
2. 同步任务: 插件会使用 API 密钥与 Todoist 进行双向同步，确保任务在 Obsidian 和 Todoist 之间保持一致。

4. 项目安装方式

4.1 通过 Obsidian 社区插件市场安装

1. 打开 Obsidian: 启动 Obsidian 应用。
2. 进入社区插件市场: 在 Obsidian 中，点击左侧边栏的“设置”图标，然后选择“社区插件”。
3. 搜索插件: 在搜索框中输入“Todoist”，找到“Sync with Todoist Plugin”插件。
4. 安装插件: 点击“安装”按钮，等待安装完成。
5. 启用插件: 安装完成后，点击“启用”按钮，启用插件。

4.2 手动安装

1. 下载插件: 从 GitHub 仓库 下载插件的最新版本。
2. 解压插件: 将下载的插件文件解压到 Obsidian 的插件目录（通常位于 ~/.obsidian/plugins/）。
3. 启用插件: 在 Obsidian 中，进入“社区插件”页面，找到并启用插件。

通过以上步骤，您可以成功安装并使用 Obsidian Todoist 插件，实现 Obsidian 与 Todoist 之间的任务双向同步。

obsidian-todoist-plugin Materialize Todoist tasks in Obsidian notes 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-todoist-plugin