Skip to content
This repository has been archived by the owner on Nov 10, 2020. It is now read-only.
/ swiftdoc.org Public archive

Auto-generated documentation for Swift. Command-click no more.

License

Notifications You must be signed in to change notification settings

SwiftDocOrg/swiftdoc.org

Repository files navigation

SwiftDoc.org

Auto-generated documentation for Swift. Command-click no more.

Installation

SwiftDoc.org is created via a two-step process:

  1. The swiftdoc-parser utilities parse a set of Swift header files and output a set of HTML files with YAML front-matter.
  2. 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

Contributions

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.

Contact

@SwiftDocOrg on Twitter.

License

The parsing and HTML generating utilities are available under the MIT license. See the LICENSE file for more info.

About

Auto-generated documentation for Swift. Command-click no more.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages