jazzy

Generate docs using Jazzy

jazzy
Supported platforms ios, mac
Author @KrauseFx

1 Example

jazzy

Parameters

Key Description Default
config Path to jazzy config file

* = default value is dependent on the user's system


Documentation

To show the documentation in your terminal, run

fastlane action jazzy

CLI

It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run jazzy

To pass parameters, make use of the : symbol, for example

fastlane run jazzy parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.


Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub


Back to actions