Auto-generated documentation for Swift. Command-click no more.
SwiftDoc.org is created via a two-step process:
- The
swiftdoc-parserutilities parse a set of Swift header files and output a set of HTML files with YAML front-matter. - Jekyll converts those files, along with the remaining files in this repository, to create the SwiftDoc.org site.
If you have Jekyll installed, you can run SwiftDoc.org locally with the following commands:
$ git clone https://github.com/SwiftDocOrg/swiftdoc.org.git
$ cd swiftdoc.org
$ bundle install
$ foreman start
Issues and pull requests should be filed in this repository relating to:
- errors or bugs in SwiftDoc.org
- feature requests
For errors in the actual documentation on SwiftDoc.org, please refer to the swiftdoc-parser project instead.
@SwiftDocOrg on Twitter.
The parsing and HTML generating utilities are available under the MIT license. See the LICENSE file for more info.