A companion project to the NSHipster article about Swift Documentation.
- Xcode
- Git 2.16.2+
- Ruby 2.4.3+
- Bundler
First, clone the repository by opening Terminal.app and running the following commands:
$ git clone [email protected]:NSHipster/Swift-Documentation-Example.git
$ cd Swift-Documentation-Example
Next, download project dependencies with Bundler using the command:
$ bundle install
Use Jazzy to generate web pages from the documentation comments of this Swift project:
$ bundle exec jazzy -o Docs
Now open the index.html
from the Docs
directory
to view the generated documentation:
$ open Docs/index.html
This project is released under the MIT License. See the LICENSE file for more info.
NSHipster® and the NSHipster Logo are registered trademarks of Read Evaluate Press, LLC.