Markdown - mcbride-clint/DeveloperCurriculum GitHub Wiki

Markdown is a markup language that can then be stylized by many programs to make a formatted document. This markup language designed to be easily human readable in both plain text and the final formatted document.

Markdown has become popular with developers as it is a convenient way to create readme and other documentation files in plaintext. This plaintext works well with version control systems such as git to version your documentation along with your source code.

Github, Azure DevOps and other popular source control systems use Markdown when displaying readme's and other documentation files. This wiki is also completely written in Markdown.

Some Examples

There are 6 levels of headings. Each level is denoted with increasing numbers of #.

Header 1 # Header 1

Header 2 ## Header 2

Header 3 ### Header 3

Header 4 #### Header 4

Header 5 ##### Header 5
Header 6 ###### Header 6

Lists

Ordered Lists are made by just putting a number, period, and space at the beginning of the line.

  1. First
  2. Second
  3. Third

Unordered Lists

Unordered Lists are made by putting either a * or - or + at the beginning of the line. Two spaces before an item can nest items in the list.

  • Item
  • Item
    • Sub Item
  • Item

Blocks

Block Quotes can be created with a > at the beginning of the line.

"You miss 100% of the shots you donโ€™t take."
โ€“ Wayne Gretzky
โ€“ Michael Scott

Code Blocks can be created with 3 "`" tick marks. You can also provide the language that the code is and some formatters will colorize the code to the best of their ability. (csharp, html, javascript)

string x = "Hello World";

Checkboxes

  • Unchecked Box - [ ] Unchecked Box
  • Checked Box - [X] Checked Box

Font Styling

Bold Text **Bold Text**

Italics Text __Italics Text__

StrikeThrough ~~StrikeThrough~~

Hyperlinks

![Image Url](Image Url)

[Link Url](Link Url)

Other examples are harder to denote within a markdown file. Look below at the Markdown Cheatsheet for many more examples.

See Also