/swiftdoc.org

Documentation and resources for the Swift community
  1. HTML 40.2%
  2. CSS 27.0%
  3. JavaScript 18.8%
  4. Ruby 14.0%
HTML CSS JavaScript Ruby
Find file
Latest commit a34efa4 Sep 20, 2016 @swiftdoc-bot swiftdoc-bot Nightly build of swift/master@8fb4dee, 2016-09-20 01:40:35
Permalink
Failed to load latest commit information.
_assets Tweak CSS for longer text spans May 12, 2016
_data
_includes Prep for switch to make Swift 3 the primary version Sep 20, 2016
_layouts
_plugins Upgrade to Jekyll 3.0. Mar 6, 2016
_posts Updating for 2.0b6 Sep 15, 2015
_site @ b8425f1 Update site Jul 11, 2016
assets Revise footer. Jan 8, 2016
news Finish better version switching system. Mar 20, 2016
v1.2 Changes for Swift v2.0, moved directories. Sep 26, 2015
v2.0
versions Add versions page, fix version-related issues. Mar 26, 2016
.gitignore Prep for switch to make Swift 3 the primary version Sep 20, 2016
.gitmodules added back submodule for generated _site Jan 3, 2015
404.md
CC-BY-NC-LICENSE.md Initial commit Jan 3, 2015
Gemfile Upgrade to Jekyll 3.0. Mar 6, 2016
Gemfile.lock Upgrade to Jekyll 3.0. Mar 6, 2016
LICENSE
Procfile Stop watching the generated site. Dec 31, 2015
README.md
_config.yml Prep for switch to make Swift 3 the primary version Sep 20, 2016
_redirects.yml Prep for switch to make Swift 3 the primary version Sep 20, 2016
favicon.ico Initial commit Jan 3, 2015
index.html Prep for switch to make Swift 3 the primary version Sep 20, 2016

README.md

SwiftDoc.org

Documentation and resources for the Swift community
http://swiftdoc.org/

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 preambles.
  2. 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
$ 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, see the swiftdoc-parser repository instead.

Contact

Follow @SwiftDocOrg on Twitter.

License

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