Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 1.5 KB

README.md

File metadata and controls

25 lines (21 loc) · 1.5 KB

#Contribute Please refer to our contribution page for general guidelines on how to contribute.

#Contributing to documentation

Setting up Jekyll on Windows

  1. Install Ruby and add it to your system path environment variable
  2. Download the Ruby DevKit, and follow the installation instructions here
  3. Install Python 2.7.x
  4. Using Command Prompt, Install jekyll using ruby gems. gem install jekyll

Iterating on documentation

  1. Using Command Prompt, from within the content folder start a local server: jekyll serve --watch
  2. If prompted by the firewall, allow Jekyll to serve content
  3. Open your web browser and point it to the local server. localhost:4000 is the default
  4. Now you have your own version of the documentation site!
  5. You can make changes to the pages using your favorite text editor.

Documentation rules

  • 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