SYAK:同步 SiYuan 内容块到 Anki, 自动更新, 自动删除
如果觉得有帮助, 麻烦点个 Star⭐
⚠ 初次使用请提前备份 Anki, 以免数据误删!
Prerequisite
- Anki 需要安装 AnkiConnect 插件, code 为
2055492159, 默认端口8765 - 支持 Python 3.9 以上版本
- SiYuan 默认端口为
6806 - 同步时, 保持 SiYuan 和 Anki 同时运行
Install
pip install -U syak
Usage
-
新建一个
card 文档块, 名字支持前后缀, 例如@card -
在需要制卡的内容块后面引用
card 文档块 -
制卡内容块为某个容器块下的叶子块时, 卡片正面为制卡内容块, 背面为整个容器块
-
制卡内容块为文档块下的叶子块时, 卡片正面为制卡内容块, 背面为空
-
运行命令
syak -p SiYuan数据根路径(data目录的上一级) 即可同步 -
运行周期任务
syak -p SiYuan数据根路径(data目录的上一级) -i (seconds), 例如每 5 分钟运行一次syak -p SiYuan数据根路径(data目录的上一级) -i 300 -
后台运行
- Linux&macOS
nohup syak -p SiYuan数据根路径(data目录的上一级) -i (seconds) & - Windows
start /b syak -p SiYuan数据根路径(data目录的上一级) -i (seconds)
- Linux&macOS
-
查看更多选项运行
syak -h
Demo
Feature
- 添加 SiYuan URL 跳转链接
- 自动更新, SiYuan 更新内容块后, Anki 自动更新
- 自动删除, 删除
card 引用块, Anki 自动删除 - 根据文档块层级自动建立 deck 层级
- 支持 media 文件
- 自动删除 empty deck
- 同步完成时, 发送同步信息给 SiYuan, 停留 5s
Not Support (currently)
- Close
- 代码块语法高亮
- 超级块未适配
More
-
macOS 用户如果遇到同步耗时较长的问题, 可以参考:
-
FooSoft Productions - Anki-Connect
Starting with Mac OS X Mavericks, a feature named App Nap has been introduced to the operating system. This feature causes certain applications which are open (but not visible) to be placed in a suspended state. As this behavior causes Anki-Connect to stop working while you have another window in the foreground, App Nap should be disabled for Anki:
-
Start the Terminal application.
-
Execute the following commands in the terminal window:
defaults write net.ankiweb.dtop NSAppSleepDisabled -bool true defaults write net.ichi2.anki NSAppSleepDisabled -bool true defaults write org.qt-project.Qt.QtWebEngineCore NSAppSleepDisabled -bool true -
Restart Anki.
-
-
Metadata
Release files for syak 0.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| syak-0.1.7.tar.gz | 8.7 kB | Without provenance | Details for syak-0.1.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| syak-0.1.7-py3-none-any.whl | Python 3 | none | any | Details for syak-0.1.7-py3-none-any.whl |
Total release size: 16.9 kB
Release files / syak-0.1.7.tar.gz
| Download URL | syak-0.1.7.tar.gz |
|---|---|
| Size | 8.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
364bb4497ed9921859ef6daef1a32c9190793c577dc40ce249d603e855e057b9
|
|
BLAKE2b-256 checksum How to use checksums |
103a02294492be14f2c9137e6976b2fdf923a67237484c7eb64efd1c8dd9656e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.1 CPython/3.9.5 Darwin/21.6.0
|
Release files / syak-0.1.7-py3-none-any.whl
| Download URL | syak-0.1.7-py3-none-any.whl |
|---|---|
| Size | 8.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
16afd8570448e08e87be62cda9b88f53a3d18cd397005686a56b9d78d88b40d2
|
|
BLAKE2b-256 checksum How to use checksums |
3806d56c1ab6c9c94bbd61b6c86a83d219bacfb518abf2e5b3476bbb8db002e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.1 CPython/3.9.5 Darwin/21.6.0
|
Security for syak 0.1.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.