1 个不稳定版本
0.1.0 | 2023 年 3 月 6 日 |
---|
在 模板引擎 中排名 #579
500KB
445 行
安吉丁 - Markdown 笔记到 Anki 炫卡的转换!
文档仍在进行中。如果您在任何地方遇到困难,请创建一个问题。
目录
这究竟是什么?
此工具允许将您的 Markdown 笔记转换为 Anki 炫卡!它还支持图像以及 LaTeX 公式。它提供全面移动支持,包括移动 LaTeX 支持。
它是在 Jupyter 笔记本和通用文献编程的精神下创建的。这意味着,您只需在笔记中嵌入您的闪卡,它就会提取它们
此外,我们为 GitHub 和 GitLab CI 预构建了模板,因此,每次向您的 Markdown 知识库仓库提交时,都会构建一个新的 .apkg
包。
安装
目前,需要完整的 LaTeX 套件以预渲染所有 LaTeX 公式,因为移动应用程序不支持按需公式渲染。在基于 Debian/Ubuntu 的系统上
# Everything else that has pdflatex and dvisvgm should probably suffice
sudo apt install texlive-full
在我们实现自动化构建之前,您还需要以下构建依赖项
sudo apt install git build-essential pkg-config libssl-dev
以及一个 Rust 编译器,我建议使用 rustup
在用户空间中安装。
然后,只需克隆并使用以下命令构建它
git clone https://github.com/lquenti/ankiding.git
cd ankiding
cargo build --release
cd ..
您的二进制文件可以在 ./ankiding/target/release/ankiding
中找到。
快速入门
创建一个文件夹,该文件夹应代表您的炫卡名称,例如
mkdir programming
然后,例如,创建 ./programming/python.anki.md
文件,其中包含您的随意笔记,以及您认为合适的闪卡
# Python
Python is a **great** programming language because
- One can easily start programming
- It has awesome tooling
- The Jupyter support is a gamechanger for interdisciplinary work
- It has libraries for everything
> Q: Why do people use Python a lot for scripting?
>
> A: Because it has a libraries for everything
> For example:
> - subprocess for process spawning
> - os for OS integration
> - json as a json parser
Python is also used a lot in different domains such as ML or backend programming
> Q: What is the most important Python web framework
> A: Django
> Q: What are some important Python micro web frameworks?
> A: Flask and bottlepy
> Q: With which Python library would one use for modern APIs?
> A: FastAPI
您还可以链接其他本地或远程文件作为图像,并将其分割成多个 .anki.md
文件。所有其他扩展名的文件都将被忽略。
完成后,只需使用 ankiding ./programming
运行 ankiding。
最后,将 output.apkg
导入 Anki,您就完成了!
自动 CI Anki 炫卡构建
我们理解
- 许多 Anki 用户是非技术性的
- 安装完整的 LaTeX 是一大麻烦
此外,Anki牌组在协同工作方面臭名昭著,而Markdown因其简单性,非常适合任何版本的版本控制。因此,我们为GitHub和GitLab创建了完全自动化的CI工作流程。
贡献
我乐于接受任何形式的帮助,但到目前为止我仍在尝试一切。因此,虽然我乐于接受任何形式的帮助,但对于大的变化/想法,请先与我联系,以确保它符合更广泛的愿景。
一旦一切都有文档和正式规范,并且更加稳定,我就很高兴进行更改:
依赖项
~43–59MB
~1M SLoC