Obsidian CardBoard 插件安装与配置指南
1. 项目基础介绍和主要编程语言
Obsidian CardBoard 是一个为 Obsidian 笔记应用开发的插件,旨在通过看板(Kanban)风格的方式,使任务管理变得更加愉快。该项目的主要编程语言是 TypeScript,这是一种在 JavaScript 基础上扩展的编程语言,广泛用于前端开发。
2. 项目使用的关键技术和框架
Obsidian CardBoard 插件使用了以下关键技术和框架:
- TypeScript:作为主要的编程语言,用于编写插件的核心逻辑。
- Webpack:用于打包和构建插件的代码。
- Jest:用于单元测试,确保代码的稳定性和可靠性。
- Obsidian API:Obsidian 提供的 API,用于与 Obsidian 应用进行交互。
3. 项目安装和配置的准备工作和详细安装步骤
准备工作
在开始安装和配置 Obsidian CardBoard 插件之前,请确保你已经完成以下准备工作:
- 安装 Obsidian:确保你已经在你的设备上安装了 Obsidian 笔记应用。
- 启用第三方插件:在 Obsidian 设置中,启用第三方插件功能。
详细安装步骤
-
下载插件:
- 打开 Obsidian 应用,进入“设置”(Settings)。
- 在左侧菜单中选择“第三方插件”(Community Plugins)。
- 点击“浏览”(Browse)按钮,搜索“CardBoard”。
- 找到“Obsidian CardBoard”插件,点击“安装”(Install)按钮。
-
启用插件:
- 安装完成后,回到“第三方插件”页面。
- 找到“Obsidian CardBoard”插件,点击“启用”(Enable)按钮。
-
配置插件:
- 启用插件后,你可以在 Obsidian 的左侧菜单中看到一个新的图标,点击该图标启动 CardBoard 插件。
- 如果你还没有定义任何看板,系统会提示你添加一个新的看板。你可以选择以下三种看板类型之一:
- 日期型看板:适合按日期管理任务。
- 标签型看板:适合按标签管理任务。
- 空白看板:没有任何预定义的列,适合自定义看板。
- 你可以通过插件的设置页面添加、编辑、重新排序或删除列。
-
使用插件:
- 在看板中,任何任务都可以作为卡片显示在列中。要使任务显示为卡片,任务必须满足以下条件:
- 位于 Markdown 文件中。
- 不能缩进,必须位于行首。
- 使用以下格式之一:
- [ ] 任务标题
、* [ ] 任务标题
、+ [ ] 任务标题
。
- 卡片的内容取决于任务的格式,缩进的任务将显示为子任务,缩进的文本将显示为笔记。
- 你可以通过点击卡片上的编辑图标来打开包含任务的笔记,或者通过右键点击卡片来更改任务的截止日期。
- 在看板中,任何任务都可以作为卡片显示在列中。要使任务显示为卡片,任务必须满足以下条件:
通过以上步骤,你就可以成功安装并配置 Obsidian CardBoard 插件,开始使用看板风格管理你的任务了。