使用python将为知笔记中的所有笔记都导出到本地, 转化为纯markdown文本文件.
- 将所有加密笔记取消加密
- releases 页面下载对应系统的可执行文件
- 在可执行文件同级目录下创建
.env文件，配置为知笔记的用户名和密码, 参考: .env.example - 运行可执行文件
- mac 运行可执行文件出现:
无法打开"wiz2obsidian"，因为Apple无法检查其是否包含恶意软件, 错误提示
解决方案: 系统设置 -> 隐私与安全性 -> 在安全性栏目下点击仍然允许运行 wiz2obsidian
- ** 笔记标题中的特殊字符（如
/,\,:,*,?,",<,>,|等）会自动替换为下划线_，确保跨平台兼容性 - 为知笔记应用不要打开协作笔记tab页, 否则影响程序读取读取该笔记的数据.
├── output
│ ├── db
│ │ └── sync.db // sqlite3 记录笔记同步记录和笔记图片同步记录
│ ├── note // 所有导出 markdown 笔记, 图片和附件
│ └── log
│ └── log.log // 日志
协作笔记使用ws通信, 返回特定的数据格式, 需要写解析器将其解析为markdown纯文本. GitHub - websocket-client/websocket-client: WebSocket client for Python
因为使用ws通信, 为知笔记应用不要打开协作笔记, 否则影响程序读取读取该笔记的数据.
程序将笔记中的图片下载到本地, 放到笔记同级目录中 ./attachments 目录中.
程序将笔记中的图片下载到本地, 放到笔记同级目录中 ./images 目录中.
之前导出方案使用 picgo 配置图床. 考虑到上手难度太高, 遂直接放弃, 导出到本地, 用户自行处理
将所有加密笔记取消加密, 当作常规笔记处理, 避免处理加密笔记的复杂性. WizNote 加密笔记
忽略原先为知笔记中的tag, 将笔记的目录作为tag.
随着为知笔记的发展, 有如下类型的笔记
- HTML 笔记. 最初的, 使用富文本编辑器编辑的笔记
- Lite 笔记. 依旧使用富文本编辑器, 标题名需要以
.md结尾, 需要在富文本编辑器中写 markdown 文本, 进入预览模式才会进行md渲染. - 协作笔记. 现在最新的笔记格式, 支持多人协作.
项目支持处理以下几种类型的笔记：
-
HTML 笔记（document）
- 使用
html2text库直接将 HTML 转换为 Markdown. 解析后的markdown文本, 差强人意, 完全取决于富文本的格式.(可以尝试使用大模型 reader-lm-v2 这个转换效果好)
- 使用
-
Lite 笔记（lite/markdown）
- 通过 BeautifulSoup 库解析 HTML 内容
- 提取 pre 标签中的原始 Markdown 文本
-
协作笔记（collaboration）
- 通过自定义解析器处理, 手动解析拼装.
- 支持解析文本、列表、代码块、表格、图片等多种格式
- 支持解析笔记双链, 块链接,块快照,关键字
- 支持解析数学公式（LaTeX格式转换为Markdown行内公式）
- 支持解析内嵌网页（转换为链接格式）
- 支持解析流程图和附件（使用统一的附件链接格式）
- 支持解析评论内容（包括用户信息、时间戳和@提及）
- 自动忽略加密文本、上标下标、文本对齐等格式
- 使用 WebSocket 通信获取笔记数据
所有类型的笔记在解析后都会经过以下处理：
- 提取并下载笔记中的图片到同级目录
./images下 - 替换笔记中的图片链接
- 添加笔记属性（创建时间、更新时间、标签等）
- 进行 Markdown 格式优化（标题、代码块、列表等的格式修正）
半吊子python, 程序还有很多不完善之处. 待其他人完善.
程序的默认导出约定更多是符合我自己的期望, 而不是做成一个通用的工具产品. 待其他人有时间完善吧, 比如:
- 忽略原先为知笔记中的tag, 将笔记的目录作为tag, 因为我自己不用为知的tag.
- 忽略加密笔记的处理(因为我没有几篇加密笔记,直接取消加密即可, 不用为了处理加密笔记的解析写多余的代码)
- ...等等
待完善之处
- 配置导出参数, 可以更好的定制化导出
本项目支持使用 PyInstaller 将应用程序打包为可执行文件，方便非开发人员使用。
-
确保已安装所有依赖：
pip install -r requirements.txt
-
打包应用程序有两种方式：
直接运行打包脚本：
python build.py脚本会自动使用预配置的 spec 文件进行打包，完成后会在 dist 目录下生成可执行文件。
如果需要更多控制，可以手动运行 PyInstaller：
pyinstaller --clean wiz2obsidian.spec打包完成后，可执行文件将位于 dist 目录：
- Windows:
dist/wiz2obsidian.exe - macOS:
dist/wiz2obsidian - Linux:
dist/wiz2obsidian