Metadata-Version: 2.1
Name: syak
Version: 0.1.3
Summary: SiYuan sync to Anki
License: MIT
Author: why8023
Author-email: whyniaaa@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: markdown2 (>=2.4.6,<3.0.0)
Requires-Dist: pandas (>=1.5.2,<2.0.0)
Requires-Dist: psutil (>=5.9.0,<6.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Description-Content-Type: text/markdown

SYAK:同步SiYuan内容块到Anki, 自动更新, 自动删除

# Prerequisite

1. Anki 需要安装 AnkiConnect 插件, code 为 `2055492159`​, 默认端口 `8765`​
2. 支持 Python 3.9 以上版本
3. SiYuan 默认端口为 `6806`​

# Install

```
pip install syak
```

# Useage

1. 新建一个 `card`​ ​文档块, 名字支持前后缀, 例如 `@card`​​
2. 在需要制卡的内容块后面引用 `card`​ ​文档块
3. 制卡内容块为某个容器块下的叶子块时, 卡片正面为制卡内容块, 背面为整个容器块
4. 制卡内容块为文档块下的叶子块时, 卡片正面和背面都是制卡内容块
5. 运行命令 `syak -p SiYuan数据根路径(data目录的上一级)`​ ​即可同步
6. 查看更多选项运行 `syak -h`​​

# DEMO

​![demo](demo.gif)​

# Feature

1. 自动更新, SiYuan更新内容块后, Anki自动更新
2. 自动删除, 删除`card`​引用块, Anki自动删除
3. 根据文档块层级自动建立 deck 层级
4. 支持 media 文件
5. 自动删除 empty deck

# Not Support

1. Close
2. 代码块高亮
3. 超级块未适配

# MORE

使用带有定时运行脚本功能的软件,如`Keyboard Maestro`​或者`Quicker`​实现后台无缝同步
