NOTES.md

Pre-requisites

• bundler (to install it in Fedora yum install rubygem-bundler)
• run bundle install to install all the things needed to compile the markdown to HTML

General rules

• make whatever changes you want to do and save them
• run make (it should run jekyll and generate the site inside _site/)
• open _site/index.html with a web browser to see how the site looks
• Commit to master first, always
• Once you are happy, push your master branch

To Publish to the live site

Do this with permission only and always after review. Needless to say, always do this after it's committed to master.

To publish to the live docs site, run make publish to push it out to gh-pages. Within a few seconds it will be in the public site

Reference links:

• Github pages: https://help.github.com/categories/20/articles
• Jekyll: https://github.com/mojombo/jekyll
• Markdown Syntax: http://daringfireball.net/projects/markdown/syntax

CSS Styling

For CSS styling, we use Twitter Bootstrap http://twitter.github.com/bootstrap/components.html

Markup

For markup, we use Markdown. Here is a markdown cheat sheet.

Format Text

Headers

This is an

tag

This is an

tag

This is an

tag

Text styles

This text will be italic This will also be italic This text will be bold This will also be bold

You can combine them

Lists

Unordered

• Item 1
• Item 2
  • Item 2a
  • Item 2b

Ordered

1. Item 1
2. Item 2
3. Item 3
   • Item 3a
   • Item 3b

Miscellaneous

Images

Format:

Links

http://github.com - automatic! GitHub

Blockquotes

As Kanye West said:

We're living the future so the present is our past.

Code Examples in Markdown

Syntax highlighting with GFM

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

Or, indent your code 4 spaces

Here is a Python code example without syntax highlighting:

def foo:
  if not bar:
    return true

Inline code for comments

I think you should use an <addr> element here instead.