Obsidian_to_Anki 项目使用教程
1. 项目介绍
Obsidian_to_Anki 是一个开源项目,旨在帮助用户将文本或 Markdown 文件中的闪卡(flashcards)添加到 Anki 中。该项目支持在 Obsidian 中作为插件运行,也可以作为 Python 脚本从命令行运行。它特别针对 Obsidian 的 Markdown 语法进行了优化,支持用户自定义的闪卡语法。
2. 项目快速启动
2.1 安装 Anki 和 AnkiConnect
首先,确保你已经安装了 Anki 和 AnkiConnect 插件。AnkiConnect 是一个允许外部程序与 Anki 通信的插件。
2.2 安装 Obsidian_to_Anki 插件
如果你使用 Obsidian,可以通过以下步骤安装 Obsidian_to_Anki 插件:
- 打开 Obsidian,进入“社区插件”列表。
- 搜索并安装 Obsidian_to_Anki 插件。
- 在 Anki 中,导航到
Tools -> Addons -> AnkiConnect -> Config
,并确保配置如下:
{
"apiKey": null,
"apiLogPath": null,
"webBindAddress": "127.0.0.1",
"webBindPort": 8765,
"webCorsOrigin": "http://localhost",
"webCorsOriginList": [
"http://localhost",
"app://obsidian.md"
]
}
- 重启 Anki 以应用更改。
2.3 使用 Python 脚本
如果你更喜欢使用 Python 脚本,可以按照以下步骤操作:
- 下载
obstoanki_setup.py
文件并将其放置在你希望安装脚本的文件夹中。 - 运行
obstoanki_setup.py
,例如通过双击文件资源管理器中的文件。这将自动下载最新版本的脚本和所需的依赖项。 - 运行
obsidian_to_anki.py
,例如通过双击文件资源管理器中的文件。这将生成一个配置文件obsidian_to_anki_config.ini
。
3. 应用案例和最佳实践
3.1 自定义笔记类型
Obsidian_to_Anki 支持自定义笔记类型,这意味着你可以创建符合自己学习需求的笔记类型,而不仅限于 Anki 的 6 种内置笔记类型。
3.2 忽略特定文件和文件夹
你可以通过插件设置指定要忽略的文件和文件夹。例如:
**/*excalidraw.md - 忽略所有以 excalidraw.md 结尾的文件
Template/** - 忽略 Template 文件夹中的所有文件(包括子文件夹)
**/private/** - 忽略所有名为 private 的文件夹中的文件
3.3 使用 Markdown 格式
Obsidian_to_Anki 支持 Markdown 格式,包括数学公式、嵌入图像和音频等。这使得你可以创建丰富的学习材料。
4. 典型生态项目
4.1 Anki
Anki 是一个基于间隔重复(Spaced Repetition)的记忆辅助软件,广泛用于学习和记忆各种知识。
4.2 Obsidian
Obsidian 是一个强大的知识管理和笔记工具,支持 Markdown 格式,适合用于创建和组织学习材料。
4.3 AnkiConnect
AnkiConnect 是一个 Anki 插件,允许外部程序与 Anki 通信,是 Obsidian_to_Anki 项目的关键依赖。
通过这些工具的结合使用,你可以高效地创建、管理和复习学习材料,提升学习效率。