Skip to content

Latest commit

 

History

History
29 lines (27 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

29 lines (27 loc) · 1.09 KB

Contributing

Source Code

todo

Documentation

  1. Source
    • Documentation is in the /docs directory of the master branch on GitHub
  2. Local GitHub Pages
    • To test doc access before pushing, and to make changes to default layouts and styles, you can build through Jekyll locally.
    • Install Ruby 2.3 and add its bin directory to your PATH.
    • Install Bundler: 
      gem install bundler
    • Download the CURL CA Certs from http://curl.haxx.se/ca/cacert.pem and save in your Ruby installation directory.
    • Set environment variable SSL_CERT_FILE to point to this this cacert.pem file location.
    • Install Ruby DevKit: https://github.com/oneclick/rubyinstaller/wiki/Development-Kit
    • Install Jekyll and all its dependencies (in the /docs directory): 
      bundle install
    • Build GitHub pages site locally (in the /docs directory): 
      bundle exec jekyll serve --incremental --watch --baseurl ''
    • Access locally in your browser: http://127.0.0.1:4000/