org-anki 使用教程

org-anki 使用教程

org-anki Sync org notes to Anki via AnkiConnect 项目地址: https://gitcode.com/gh_mirrors/or/org-anki

1. 项目介绍

org-anki 是一个非侵入性小模式，用于将 org-mode 笔记同步到 Anki。它通过 AnkiConnect 插件与 Anki 进行交互。此项目允许用户创建“基础”或“Cloze”类型的卡片，并且支持同步标签。

2. 项目快速启动

在开始使用 org-anki 之前，请确保已经满足了以下条件：

• 安装了 Anki 应用并启动了 AnkiConnect 插件。
• 在 org-anki 的配置文件中设置了正确的 AnkiConnect 监听地址和 API 密钥。

下面是一个快速启动的步骤：

;; 设置 AnkiConnect 监听地址
(setq org-anki-ankiconnnect-listen-address "http://127.0.0.1:8765")

;; 设置 AnkiConnect API 密钥
(setq org-anki-api-key "your_api_key_here")

;; 设置默认牌组名称
(setq org-anki-default-deck "my-target-deck")

接下来，打开你的 org 文件，并使用以下命令：

• 使用 M-x org-anki-sync-entry 同步当前条目到 Anki。
• 使用 M-x org-anki-update-all 更新缓冲区中所有已经设置了 ANKI_NOTE_ID 属性的条目。
• 使用 M-x org-anki-sync-all 添加或更新缓冲区中的所有条目。

3. 应用案例和最佳实践

创建基础卡片

将光标放在 org 文件的条目标题上，然后运行 org-anki-sync-entry。这将创建一个基础卡片，其中标题是卡片正面，内容是背面。

创建 Cloze 卡片

如果标题中包含了 Cloze 语法（例如 {{...}}），那么标题将用于创建问题和答案。将光标放在标题上，然后运行 M-x org-anki-cloze-dwim。

同步标签

org-anki 支持将 org 文件中的标签同步到 Anki。确保在 org 文件中正确设置了标签，同步时它们将被自动包含。

4. 典型生态项目

org-anki 可以与多个相关项目配合使用，以下是一些典型的生态项目：

• AnkiConnect：一个 Anki 插件，提供 HTTP API，允许外部程序如 org-anki 与 Anki 交互。
• pandoc：文档转换工具，可以与 org-anki 结合使用，将 HTML 转换为 org 格式。

以上是 org-anki 的基本使用教程，希望对您有所帮助。在开始使用之前，请确保阅读了项目的完整文档以了解所有功能和细节。

org-anki Sync org notes to Anki via AnkiConnect 项目地址: https://gitcode.com/gh_mirrors/or/org-anki