OneNote Markdown 导出器技术文档

OneNote Markdown 导出器技术文档

onenote-md-exporter ConsoleApp to export OneNote notebooks to Markdown formats 项目地址: https://gitcode.com/gh_mirrors/on/onenote-md-exporter

---

安装指南

系统要求：

• 操作系统：Windows 10 或更高版本
• OneNote：2013版或之后，不含Windows应用商店版的OneNote
• Microsoft Word：2013版或之后

步骤：

1. 访问Release页面，下载最新版本的OneNoteMdExporter。
2. 解压缩下载的ZIP文件到任意目录。
3. 确保需要导出的OneNote笔记本已加载在OneNote中。

使用说明

1. 双击运行解压后的OneNoteMdExporter.exe。
2. 选择要导出的笔记本。
3. 选择导出格式（Markdown或Joplin Raw Directory）。
4. （可选）点击高级设置以调整如页面层次结构处理、资源文件夹位置等选项。
5. 开始导出后，可休息片刻，程序会自动完成并打开导出文件夹。

命令行支持：通过执行OneNoteMdExporter.exe --help查看详细指令。

API使用文档

本工具主要通过图形界面交互操作，并无传统意义上的API接口。但命令行参数构成了其“简易API”形式，使用--help命令获取所有可用的命令行参数和其用途。

项目特性与限制

• Markdown导出支持层级结构转换为文件夹、自定义资源存储位置、元数据头添加等。
• Joplin迁移保留笔记本结构，支持附件和图像，但部分高级格式化特性可能丢失，例如嵌入表格中的图片处理有已知问题。

技术细节

• .NET 8构建的独立应用程序。
• 利用Office Interop APIs读取OneNote内容，通过Pandoc将页面转为Markdown格式。
• 离线工作模式，无需连接微软云服务。
• 包含XML预处理和正则表达式后处理步骤来优化格式。

许可证

• 软件遵循GPLv3许可协议，源码二次分发需遵守相应规定。请注意，导出过程中可能会有数据丢失风险，建议备份原笔记。

编译源代码

• 需要安装.NET 8 SDK。
• 克隆仓库后，手动放置Pandoc的pandoc.exe到指定目录。
• 使用Visual Studio 2019或MSBuild进行编译，注意命令行编译可能因COM引用限制而不适用。

---

请注意，上述内容是基于提供的Readme文件编写的中文技术文档概述，实际使用时应参照原始文档的最新信息。

onenote-md-exporter ConsoleApp to export OneNote notebooks to Markdown formats 项目地址: https://gitcode.com/gh_mirrors/on/onenote-md-exporter