Working with Git and Github

Basic Documentation

All About Markdown

First off: in Markdown, whitespace matters, specifically spaces. If something isn’t rendering properly, check the spaces.

Github uses a flavored markdown. Here’s the spec.
CheatSheet and Tutorial by CommonMark

Headers

Starting a line with a hash # and a space makes a header.

### Header 3

The more #, the smaller the header.

Tables

Create tables with pipes | and hyphens -. Pipes separate columns and hyphens signify the column headers. You must include a blank line before each table row in order for it to correctly render. See Organizing information with tables.

 | Column One | Column Two |
 | --- | ---: |
 | Lorem | 12,300 |
 | Ipsum | 5,032 |
 | Dolor | 375,929 |
Column One Column Two
Lorem 12,300
Ipsum 5,032
Dolor 375,929

Code

Abbreviation Code Type
js javascript
php PHP
sh bash
feature cucumber
console sh-session
css css
html html
sql sql
txt txt
yml yaml 
  var i;
  for (i=0; i<5; i++) {
    console.log(i);
  }

Emphasis

Wrap text with asterisks * or underscores _, single for italics and double for bold.

Escape with a backslash \* or \_ if you want the asterisks/underscores to be themselves.

Square brackets with link text + parenthesis with link URL.

[My Repositories](https://github.com/cathysnider/)

My Repositories

Graphics

Exclamation point + square brackets with alt text + parenthesis with image URL.

![Pears](https://spot.colorado.edu/~sniderc/images/digitalart/pears.jpg)

Pears

Blockquotes

Use a GreaterThan > sign

> Last night I dreamt I went to Manderley again.

Last night I dreamt I went to Manderley again.

Lists

Bulleted List

* List item
  * Nested list item

Ordered List

1. List item
   1. Nested list item
  1. Bananas
  2. Berries
    1. Black
    2. Blue
    3. Rasp
    4. Straw
      1. Everbearing
      2. Junebearing
  3. Cherries
  4. Mangos
    Line up unbulleted text with text above it.

Task List

A task list is a list with checkboxes instead of bullets. If you include a task list in the body of an issue or pull request, you’ll see a progress indicator in your issue list. The syntax for a task list is very specific: hyphen-space-square bracket-space-square bracket - [ ]

back