Documentation for the Windows Developer Program for IoT by Microsoft Open Technologies
HTML CSS Other
Pull request Compare This branch is 1569 commits behind ms-iot:develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data
_includes
_layouts
assets
css
en-US
fonts
images
js
win10
zh-CN
.gitignore
AdvancedUsage.htm
Build2015.htm
Community.htm
Contribute.htm
Downloads.htm
Faqs.htm
Gemfile
GetStarted.htm
README.md
SigninMSConnect.htm
_config.yml
favicon.ico
favicon.png
index.htm
web.config

README.md

Contribute

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

Contributing to documentation

Setting up Jekyll on Windows

  1. We use this easy to follow Jekyll on Windows guide. Use the pygments option when you go through the install.

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