Jazzy + SourceKitten 生成多依赖库的在线文档

Jazzy + SourceKitten 介绍

Jazzy 是一个用于生成静态网站文档的工具，它可以从 Objective-C 和 Swift 代码的注释中提取信息，并生成一个美观的文档网站。

SourceKitten 是一个用于解析 Swift 和 Objective-C 代码的工具，它可以提取代码中的注释、函数、类、变量等信息，并将其输出为 JSON 格式。

生成多个依赖库的在线文档

前提条件

• 已安装 Jazzy 和 SourceKitten
• 拥有多个私有库，每个库都有自己的 README.md 文件

步骤

1. 在终端中进入到需要生成文档的库的根目录
2. 执行以下命令生成 JSON 文件：

sourcekitten doc -- -x objective-c,swift -Ximplicit-module-map /dev/null -Xwhole-module-optimization -Xcxx-module-map /dev/null -target <module-name> > <output-file>.json

例如：

sourcekitten doc -- -x objective-c,swift -Ximplicit-module-map /dev/null -Xwhole-module-optimization -Xcxx-module-map /dev/null -target LibraryA > LibraryA.json

1. 重复步骤 1 和 2，为每个私有库生成 JSON 文件
2. 在终端中进入到需要生成文档的库的根目录
3. 执行以下命令生成文档：

jazzy --config ./jazzy.yaml --sourcekitten-sourcefile <source-file>.json --module <module-name> --output <output-directory>

例如：

jazzy --config ./jazzy.yaml --sourcekitten-sourcefile LibraryA.json --module LibraryA --output LibraryA-docs

1. 重复步骤 4 和 5，为每个私有库生成文档
2. 将生成的文档部署到 Github page 或者 Gitlab page

总结

本文介绍了如何利用 Jazzy + SourceKitten 生成多个私有库的在线文档，并将其部署到 Github page 或者 Gitlab page 上。希望本文能对您有所帮助。