GithubHelp home page GithubHelp logo

buddax2 / swiftdoc.org Goto Github PK

View Code? Open in Web Editor NEW

This project forked from swiftdocorg/swiftdoc.org

0.0 1.0 0.0 2.6 MB

Documentation and resources for the Swift community

Home Page: http://swiftdoc.org/

License: MIT License

Ruby 1.97% CSS 5.63% JavaScript 3.05% HTML 89.35%

swiftdoc.org's Introduction

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.

swiftdoc.org's People

Contributors

natecook1000 avatar timtyrrell avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.