shiqi-lu/roam2anki: roam2anki is a project to export Roam Research note to anki

[kunpeng9]

roam2anki 用来把 Roam Research 的笔记转成 anki 进行记忆

已经完成所有规划的功能，已支持 roam 中的所有样式，包括行内、行间公式、代码块、高亮、加粗、图片、超链接等等，其中第一级会解析为问题，第二级和往后级别均解析为第一级的答案

1. 下载 roam2anki.py 和 roam2anki 模板. apkg
2. 第一次操作先在 anki 中导入 roam2anki 模板. apkg
3. 新建一个 txt 文件如 example.txt，把要导入的 roam 字段粘贴到文本中，注意第一级为问题，第二级以下都是答案
4. 运行 python 脚本 python roam2anki.py example.txt，程序把转换成对应的只有两列的 csv 文件，问题是第一列，回答是第二列
5. 把 csv 导入到 anki 中，保持默认设置即可。即 fields separated by: Tab；勾选上 Allow HTML in fields；Field 1 为正面；field 2 为背面

• 支持所有样式：加粗、斜体、高亮、删字符、行内代码、超链接

• 支持图片并居中，支持引用图片

• 支持答案里最高 10 级的缩进

• 问题和答案支持块内多行

• 删除 alias 和双中括号

• 把同级问题合并成 anki 同一个问题

• 支持问题和答案的行内公式、引用的行内公式

• 支持多行行间公式，引用的多行行间公式，同时支持块内的新起的多行行间公式，但要注意新起一行，不能续着写

• 支持代码块导入和语法高亮，支持引用代码块，若有必要并可强制选择代码块高亮语言

• 支持标题字号 h1 到 h3

• 涉及到 html 的 <、>、&、" 等字符放到 anki 前进行转义，保证所有字符都能显示

• 答案和问题的代码块必须要新起一个块或块内新起一行，且这一行必须以 3 个反引号开始，即不支持代码块放在一行中间，原因是难以解析，且代码块展示就是会新起一行，就人工新起一行吧，结尾也要新起一行

• 只支持无序列表 (Bulleted List)，不支持有序列表 (Numbered List) 和文档 (Document)，原因是有序列表难以判断和解析，支持文档模式会和现有的块内多行的判断有歧义

• roam2anki.py 提供了批量转换的方法，第二个选项 python roam2anki.py example ...，若 example 为一个文件夹，会寻找 example 下的所有以. txt 结尾的文件进行转换，后续可接多个文件或文件夹

• roam2anki 只支持语法正确时的解析，即保证在 roam 中能正确解析的，导出 anki 后也正确解析，不正确的语法，或故意为难解析器的，，我也没办法哇

• roam2anki 目前是作者写给自用，若使用过程中发现有解析出来的 bug，请提一个 issue

• python >= 3.7

• pandas >= 1.0.1 https://github.com/shiqi-lu/roam2anki