Guide To Markdown

Links

• Easy: Github Official Markdown Tutorial
  • Simple Syntax
• Moderate: Markdown Everywhere on GitHub
  • Advanced Code Blocks
  • Advanced Tables
  • Advanced URL Formatting
• Expert: GFM Technical Specification
  • Converting between HTML and Markdown
  • Formal Definition and Format

Quick Introduction

Markdown is the markup language we use to style text on GitHub.

It's useful for making easy to read documentation without much effort. You can use it to insert_a_line_of_code(); in the middle of a sentence, and also to have:

/*
 * A block of code that sits on its own with syntax highlighting!
 */
function helloWorld() {
   document.write("Hello, World!");
}

As a matter of preference, I would recommend relegating the use of bolding and italics to important or key words.

Definitions

term	definition
markup language	A system for marking or tagging text to indicate logical structure (such as paragraphs) and give instructions for display it.

Quick Reference

markdown	result
*italic*	italic
**bold**	bold
`code line`	code line
## Big Header with line under it
### Little Header
~~strikethrough~~	strikethrough
* List Item
[link text](http://github.com/)	link text
> Quote
:thumbsup:	👍

Example (Markdown for the Above Sections)

## Links
* [Easy: Github Official Markdown Tutorial](https://guides.github.com/features/mastering-markdown/)
  * Simple Syntax
* [Moderate: Markdown Everywhere on GitHub](https://help.github.com/en/categories/writing-on-github)
  * Advanced Code Blocks
  * Advanced Tables
  * Advanced URL Formatting
* [Expert: GFM Technical Specification](https://github.github.com/gfm/)
  * Converting between HTML and Markdown
  * Formal Definition and Format

## Quick Introduction

**Markdown** is the *markup language* we use to style
text on GitHub.

It's useful for making easy
to read documentation without much effort.  You can use it to `insert_a_line_of_code();` in the
middle of a sentence, and also to have:
```javascript
/*
 * A block of code that sits on its own with syntax highlighting!
 */
function helloWorld() {
   document.write("Hello, World!");
}
```
As a matter of preference, I would recommend relegating the use of **bolding** and *italics* to important or key words.

### Definitions
|term|definition|
|--|--|
|markup language|A system for marking or tagging text to indicate logical structure (such as paragraphs) and give instructions for display it.|