Flashcards 插件技术文档

Flashcards 插件技术文档

flashcards-obsidian 🎴 An Anki plugin for Obsidian.md 项目地址: https://gitcode.com/gh_mirrors/fl/flashcards-obsidian

---

安装指南

步骤一：在Obsidian中安装插件

1. 打开您的Obsidian应用。
2. 转至设置页面，点击“社区插件”选项卡。
3. 确保“安全模式”已关闭。
4. 点击“浏览社区插件”按钮。
5. 在搜索栏输入“Flashcards”，找到对应的插件。
6. 单击“安装”，待安装完成后关闭插件浏览器，并激活该插件。

步骤二：安装AnkiConnect

1. 在您的Anki应用程序中，访问“工具”> “添加组件”菜单。
2. 在弹出窗口选择“获取附加组件...”。
3. 输入ID 2055492159，然后点击确定以安装AnkiConnect。

步骤三：授予权限

• 在Obsidian的Flashcards插件设置中保持Anki打开状态，点击“授予权限”按钮。

---

项目使用说明

Flashcards插件为Obsidian提供了与Anki的无缝集成，支持创建和管理各种类型的闪卡，如普通卡片、逆序卡片、间隔重复卡片等。以下是如何开始使用的快速入门：

• 使用#card来标记标准闪卡。
• 对于反向问答，使用#card-reverse或#card/reverse。
• 若要实施间隔重复，应用#card-spaced或#card/spaced标签。
• 直接在文本中采用Question::Answer格式插入内联样式问题与答案。
• 支持高级特性如Cloze删除（使用==, {}, 或 {2:Cloze}）以及对LaTeX、图片、音频的支持。

详细操作步骤请参考项目Wiki。

---

项目API使用文档

本部分在官方文档中未提供详细的API接口说明。通常，与AnkiConnect的交互是通过其内置API完成，具体细节可查阅AnkiConnect的官方文档以了解如何通过脚本或插件与其进行通讯。对于Flashcards插件，大部分功能通过插件界面直接实现，无需直接调用API。

---

项目安装方式

安装流程已在上述“安装指南”部分详述，涵盖了在Obsidian与Anki环境下的完整配置过程，确保用户能够顺利启用并利用此插件进行学习资料的闪卡式复习。

---

请注意，任何贡献或反馈均应遵循Contributing.md文件中的指导原则，如果您发现价值所在，也欢迎通过支持作者的方式表达感谢。

flashcards-obsidian 🎴 An Anki plugin for Obsidian.md 项目地址: https://gitcode.com/gh_mirrors/fl/flashcards-obsidian