Documentation and resources for the Swift community
http://swiftdoc.org/
SwiftDoc.org is created via a two-step process.
- The
swiftdoc-parser
utilities parse a set of Swift header files and output a set of HTML files with YAML preambles. - Jekyll converts that set of files, plus the remaining files in this repository, into the SwiftDoc.org site.
If you have Jekyll installed, you can run SwiftDoc.org locally by using these commands:
$ git clone https://github.com/SwiftDocOrg/swiftdoc.org.git
$ cd swiftdoc.org
$ jekyll serve
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, see the swiftdoc-parser repository instead.
Follow @SwiftDocOrg on Twitter.
The parsing and HTML generating utilities are available under the MIT license. See the LICENSE file for more info.