https://github.com/NSHipster/Swift-Documentation-Example

A companion project to the NSHipster article about Swift Documentation
https://github.com/NSHipster/Swift-Documentation-Example

documentation jazzy swift

Last synced: 11 months ago
JSON representation

A companion project to the NSHipster article about Swift Documentation

• Host: GitHub
• URL: https://github.com/NSHipster/Swift-Documentation-Example
• Owner: NSHipster
• Archived: true
• Created: 2018-10-05T22:55:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-24T20:26:54.000Z (over 3 years ago)
• Last Synced: 2024-11-29T18:40:29.312Z (over 1 year ago)
• Topics: documentation, jazzy, swift
• Language: Swift
• Homepage: https://nshipster.com/swift-documentation/
• Size: 101 KB
• Stars: 29
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 🚲 Bicycle - Swift Documentation Example

A companion project to the

[NSHipster article about Swift Documentation](https://nshipster.com/swift-documentation/).

## Requirements

- Xcode

- Git 2.16.2+

- Ruby 2.4.3+

- [Bundler](https://bundler.io)

## Generating Docs

First, clone the repository by opening Terminal.app

and running the following commands:

```terminal

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

$ cd Swift-Documentation-Example

```

Next, download project dependencies with Bundler using the command:

```terminal

$ bundle install

```

Use [Jazzy](https://github.com/realm/jazzy)

to generate web pages from the documentation comments of this Swift project:

```terminal

$ bundle exec jazzy -o Docs

```

Now open the `index.html` from the `Docs` directory

to view the generated documentation:

```terminal

$ open Docs/index.html

```

## License

This project is released under the

[MIT License](https://opensource.org/licenses/MIT).

See the LICENSE file for more info.

NSHipster® and the NSHipster Logo

are registered trademarks of Read Evaluate Press, LLC.