Obsidian CardBoard 插件技术文档

Obsidian CardBoard 插件技术文档

obsidian-card-board An Obsidian plugin to make working with tasks a pleasure (hopefully anyway). 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-card-board

安装指南

安装方式

1. 打开 Obsidian 应用。
2. 进入“设置” -> “社区插件”。
3. 在“社区插件”页面，点击“浏览”按钮。
4. 在搜索框中输入“CardBoard”，找到插件后点击“安装”。
5. 安装完成后，点击“启用”按钮。

项目使用说明

启动插件

安装完成后，可以通过以下两种方式启动插件：

• 使用应用侧边栏中的图标。
• 使用命令面板中的命令（允许你打开特定的看板）。

创建看板

如果没有定义任何看板，系统会提示你添加新看板。你可以选择以下三种看板类型之一：

• 基于日期的看板：类似于主截图。
• 基于标签的看板：包含内置的标签列。你需要添加你希望包含的标签列。
• 空看板：没有预定义列。

自定义看板

你可以通过插件的设置来添加、编辑、重新排序或删除列。你还可以在同一个看板中混合使用日期和标签列。

项目API使用文档

卡片

任何任务都可以作为卡片显示在看板的列中。要实现这一点，任务必须满足以下条件：

• 位于 Markdown 文件中。
• 不能缩进，必须位于行首。
• 使用以下任意一种常见的无序列表格式：
  • - [ ] 任务标题
  • * [ ] 任务标题
  • + [ ] 任务标题

卡片内容

卡片的内容取决于任务的格式：

• 缩进的内容将显示在任务的主体中。
  • 缩进的任务将显示为子任务（所有子任务将分组在一起）。
  • 缩进的文本将显示为笔记。
• 任务行上的 #tags 或包含在任务所在笔记的 tags 属性中的标签将显示在卡片顶部。
• 截止日期（如果存在）将显示在卡片的底部。

标记任务为完成

在看板上标记任务为完成时，任务将在 Markdown 文件中被标记为完成，并附加完成时间戳。

删除任务

你可以使用卡片上的垃圾桶图标删除任务。这不会从你的库中实际删除任务，而是将其用 Markdown <del> 标签包围。

编辑截止日期

你可以通过右键点击卡片并选择上下文菜单中的选项来更改任务的截止日期。

编辑任务（和悬停预览）

点击编辑图标以打开包含任务的笔记。按住 Cmd（或 Windows 上的 Ctrl）悬停在图标上以显示正常的 Obsidian 悬停预览。

项目安装方式

通过 Obsidian 社区插件安装

1. 打开 Obsidian 应用。
2. 进入“设置” -> “社区插件”。
3. 在“社区插件”页面，点击“浏览”按钮。
4. 在搜索框中输入“CardBoard”，找到插件后点击“安装”。
5. 安装完成后，点击“启用”按钮。

通过以上步骤，你可以轻松安装并开始使用 Obsidian CardBoard 插件。

obsidian-card-board An Obsidian plugin to make working with tasks a pleasure (hopefully anyway). 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-card-board