#Contribute Please refer to our contribution page) for general guidelines on how to contribute.
#Contributing to documentation
- Install Ruby) and add it to your system path environment variable
- Download the Ruby DevKit, and follow the installation instructions here)
- Install Python 2.7.7)
- Using Command Prompt, Install jekyll 2.0.3 using ruby gems. (2.1.0 cannot be used at this time)
gem install jekyll --version 2.0.3 - Using Command Prompt, uninstall pygments.rb - (it currently is incompatible with windows)
gem uninstall pygments.rb - Using Command Prompt, install pygments.rb version 0.5.0 using ruby gems
gem install pygments.rb --version 0.5.0
- Using Command Prompt, from within the content folder start a local server:
jekyll serve --watch - If prompted by the firewall, allow Jekyll to serve content
- Open your web browser and point it to the local server. localhost:4000 is the default
- Now you have your own version of the documentation site!
- You can make changes to the pages using your favorite text editor.
- For samples, please use Jekyll's Kramdown flavored Markdown) to get nice formatting when rendered as a webpage.
- For README.md files, please use Github Flavored Markdown to get nice formatting on the file browser.
- Please do not use HTML
- For samples, please append
{:target="_blank"}, so the link opens in a new page