Swift Documentation Example

A companion project to the NSHipster article about Swift Documentation.

Requirements

  • Xcode
  • Git 2.16.2+
  • Ruby 2.4.3+
  • Bundler

Generating Docs

First, clone the repository by opening Terminal.app and running the following commands:

$ git clone git@github.com:NSHipster/Swift-Documentation-Example.git
$ cd Swift-Documentation-Example

Next, download project dependencies with Bundler using the command:

$ bundle install

Now, use Jazzy to generate web pages from the documentation comments of this Swift project:

$ bundle exec jazzy

Now open the server address in a web browser to see a local copy of the site (by default, Jekyll serves to localhost on port 4000):

$ open http://localhost:4000