Cocoapods 与 jazzy

发表于 | 更新于 | 分类于 |
jazzy 是一款可以为 Swift 和 Objective-C 代码产生具有 Apple 风格的代码文档工具.

Cocoapod 与 jazzy

先上效果图 链接地址:

安装与使用

  1. 安装 jazzy

    1
    [sudo] gem install jazzy

  2. 文档生成

    1
    2
    3
    4
    cd [项目目录]
    # 默认在当前目录下生成 docs/
    # 这里导出到Github.io仓库目录
    jazzy --podspec [xxx.podspec] --output [输出路径]

Github.io

Github.io申请

由于普通Github无法解析html文件,笔者这边采用了Github.io来托管开源项目 API 文档.