AzureDevOps.WikiPDFExport 使用教程

1. 项目目录结构及介绍

AzureDevOps.WikiPDFExport 项目的主要目录结构如下：

AzureDevOps.WikiPDFExport/
├── doc/                     # 文档目录
│   ├── Contributing.md       # 贡献指南
│   ├── License.md            # 许可证信息
│   └── README.md             # 项目说明文件
├── images/                  # 图片资源目录
├── test/                    # 测试目录
├── azuredevops-export-wiki/ # 主程序目录
│   ├── azuredevops-export-wiki.sln # Visual Studio 解决方案文件
│   ├── doc/                 # 项目文档
│   ├── images/              # 项目图片资源
│   └── tests/               # 项目测试代码
├── gitignore                # Git 忽略文件
└── README.md                # 项目说明文件

目录说明：

• doc/：存放项目的文档，包括贡献指南和许可证信息。
• images/：存放项目所需的图片资源。
• test/：存放项目的测试代码。
• azuredevops-export-wiki/：存放主程序代码及相关文件。
• gitignore：定义了Git应该忽略的文件和目录。
• README.md：项目的主要说明文件，包含了项目的基本信息和使用方法。

2. 项目的启动文件介绍

项目的启动文件是 azuredevops-export-wiki.exe，该可执行文件负责执行将Azure DevOps Wiki导出为PDF的功能。执行该文件时，它将自动检测当前目录下的所有Wiki文件，并将其转换为PDF格式。

运行方式如下：

azuredevops-export-wiki.exe

如果需要指定参数进行个性化配置，可以使用以下命令格式：

azuredevops-export-wiki.exe [参数]

具体参数可以通过以下命令查看：

azuredevops-export-wiki.exe --help

3. 项目的配置文件介绍

项目的配置主要通过命令行参数进行。以下是一些主要的配置选项：

• --attachments-path：指定附件文件夹的路径。
• --breakPage：为每个Wiki页面在PDF中创建新页面。
• --chrome-path：指定Chrome或Chromium可执行文件的路径，用于支持Mermaid图。
• --css：指定样式表的路径，用于覆盖PDF中的某些组件样式。
• -c / --highlight-code：高亮显示代码块。
• -d / --debug：调试模式，记录详细信息并导出中间HTML文件。
• --exclude-paths：跳过与正则表达式模式匹配的路径下的页面。
• --filter：根据页面的YAML标签过滤页面。
• --footer-template：添加页脚模板。
• --header-template：添加页眉模板。

更多配置选项可以通过运行以下命令查看：

azuredevops-export-wiki.exe --help

以上是AzureDevOps.WikiPDFExport项目的基本使用教程，按照上述步骤，用户可以轻松地将Azure DevOps Wiki导出为PDF文件。