This is a command line program to be run on OS X's Terminal utility that performs generating a Swift documentation as Markdown format.
It's depended on SourceKittenFramework.
Please download the Pancake.pkg file in the Releases page and run it.
- Change directory to your project directory on
Terminal.app. - Run
$ pancake all --scheme YourSchemeName.
Generate the documentation as Markdown format in ./Pancake/Documentation directory.
If your project is in ./Sources/DemoKit directory and the scheme name is DemoKit, please run the following commands.
- Run
$ cd ./Sources/DemoKit - Run
$ pancake all --scheme DemoKit
Generate files in ./Pancake/Documentation directory.
$ pancake help
Available commands:
all Generate the documentation as Markdown format
help Display general or command-specific help
- OS X 10.0 and later
- Xcode 7.0 and later
Pancake is released under the MIT License.
