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 的 Emacs Lisp 项目。以下是项目的目录结构：

org-anki/
├── example/             # 示例文件目录
│   └── example.org         # 示例 org 文件
├── licenses/           # 许可证文件目录
│   └── LICENSE         # BSD-3-Clause 许可证文件
├── resources/          # 资源文件目录
│   ├── images/         # 图片文件目录
│   └── scripts/        # 脚本文件目录
├── org-anki.el         # 项目的主要 Emacs Lisp 文件
└── README.org          # 项目说明文档

• example/：包含使用 org-anki 的示例文件。
• licenses/：包含项目的许可证文件。
• resources/：包含项目使用的资源文件，如图片和脚本。
• org-anki.el：包含项目的主要功能代码。
• README.org：项目的说明文档，介绍了项目的使用方法和功能。

2. 项目的启动文件介绍

项目的启动主要是通过加载 org-anki.el 文件来实现的。在 Emacs 中，你可以通过以下命令来加载这个文件：

(load-file "/path/to/org-anki.el")

加载后，org-anki 提供的命令和功能将会生效。

3. 项目的配置文件介绍

Org-anki 的配置主要通过修改 org-anki.el 文件中的变量来实现。以下是一些主要的配置变量：

• org-anki-ankiconnnect-listen-address：设置 AnkiConnect 的监听地址，默认为 http://127.0.0.1:8765。
• org-anki-inherit-tags：控制是否启用标签继承，默认为 t（开启）。
• org-anki-default-note-type：设置默认的笔记类型，默认为 "Basic"。
• org-anki-api-key：用于 AnkiConnect 身份验证的 API 密钥。

你可以在 Emacs 的初始化文件（通常是 .emacs 或 .emacs.d/init.el）中设置这些变量，或者直接在 org-anki.el 文件中进行修改。例如：

(customize-set-variable 'org-anki-ankiconnnect-listen-address "http://127.0.0.1:8765")
(customize-set-variable 'org-anki-inherit-tags t)
(customize-set-variable 'org-anki-default-note-type "Basic")
(customize-set-variable 'org-anki-api-key "your_api_key")

确保在修改配置后重新加载 org-anki.el 文件以应用更改。

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