ConvertOneNote2MarkDown 项目使用教程

ConvertOneNote2MarkDown 项目使用教程

ConvertOneNote2MarkDownReady to make the step to Markdown and saying farewell to your OneNote, EverNote or whatever proprietary note taking tool you are using? Nothing beats clear text, right? Read on!项目地址:https://gitcode.com/gh_mirrors/co/ConvertOneNote2MarkDown

1. 项目的目录结构及介绍

ConvertOneNote2MarkDown 项目的目录结构如下：

ConvertOneNote2MarkDown/
├── LICENSE
├── README.md
├── config-example.ps1
├── ConvertOneNote2MarkDown-v2.ps1
└── Tests/
    └── ConvertOneNote2MarkDown-v2-Tests.ps1

• LICENSE: 项目许可证文件，采用 GPL-3.0 许可证。
• README.md: 项目说明文档，包含项目的基本介绍和使用方法。
• config-example.ps1: 配置文件示例，用于自定义转换过程。
• ConvertOneNote2MarkDown-v2.ps1: 项目的主脚本文件，用于执行 OneNote 到 Markdown 的转换。
• Tests/: 测试脚本目录，包含用于测试转换功能的脚本。

2. 项目的启动文件介绍

项目的启动文件是 ConvertOneNote2MarkDown-v2.ps1。该脚本文件的主要功能如下：

• 利用 OneNote 对象模型在本地工作站上将所有 OneNote 页面转换为 Word 文档。
• 使用 Pandoc 将 Word 文档转换为 Markdown 格式。
• 创建笔记本和章节的文件夹结构。
• 如果页面在 OneNote 中缩进，则在文件名前添加前缀（即“页面级别”）。

使用方法：

.\ConvertOneNote2MarkDown-v2.ps1

可以通过添加参数来控制脚本的行为，例如：

• -Verbose: 显示详细的转换日志。
• -ErrorAction Stop: 遇到错误时立即终止脚本。

3. 项目的配置文件介绍

项目的配置文件示例是 config-example.ps1。该文件用于自定义转换过程的参数，例如：

• 选择转换特定的笔记本或所有笔记本。
• 选择进行干运行或实际转换。
• 创建笔记本和章节的文件夹结构。

配置文件示例内容如下：

# 配置文件示例
$config = @{
    NotebookName = "MyNotebook"
    DryRun = $true
    CreateFolderStructure = $true
}

使用配置文件时，可以将其内容加载到脚本中，以自定义转换过程。

以上是 ConvertOneNote2MarkDown 项目的基本使用教程，希望对您有所帮助。

ConvertOneNote2MarkDownReady to make the step to Markdown and saying farewell to your OneNote, EverNote or whatever proprietary note taking tool you are using? Nothing beats clear text, right? Read on!项目地址:https://gitcode.com/gh_mirrors/co/ConvertOneNote2MarkDown