Skip to content

Markdown Primer

julia-ha edited this page Jul 9, 2021 · 2 revisions

Learn Markdown in 30 Minutes

Markdown is a simple way to format text. It allows you to mark text, so that it has basic formatting. In this short tutorial, we'll show you how to use markdown to do the following:

Viewing Your Writing in a Markdown Editor

In this quick lesson, we'll use a free online Markdown Editor called Dillinger. (You could also use another editor such as StackEdit or Editor.md. Whatever editor you choose, the editor will display the original text that you edit on the left and preview the transformed text (as it would appear in a web browser) on the right side. Select all the text in the Markdown box on the left and delete it so we can start with a fresh slate. Try creating each of these in your editor!

Create Headers/Titles

A header is text that starts a new section, like a title. To create a large header, simply insert a hashtag (#) in front of the title. You can use additional hashtags for smaller headers. These are useful for creating sub-sections of a larger document.

# Example Header

Add emphasis with Italic and Bold

Italicize words by adding a single asterisk or underscore on each side.

*italic text*

or

_italic text_

Bold words by adding two asterisks or two underscores on each side.

**bold text**

or

__bold text__

Create lists (Bulleted and Numbered)

Create a bulleted list using asterisks. Create a numbered list using numbers followed by periods.

* Bullet item 1
* Bullet item 2
* Bullet item 3

1. Numbered item 1
2. Numbered item 2
3. Numbered item 3

Create hyperlinks

Create hyperlinks by putting the link text in brackets and the link address in parentheses.

Check out [JSTOR Labs](http://labs.jstor.org)

Insert images

Insert images by starting with an exclamation point, followed by an image description for accessibility in brackets, and finally put the address where the image is stored on a server into a set of parentheses.

![Description of image for accessibility](http://example.com/imagelocation.jpg)

Insert a Horizontal Rule/Divider

Insert a horizontal rule by writing three underscores, asterisks, or hyphens in a row.

***
---
___

Insert Footnotes

Add a footnote by putting a caret followed by a number in a set of brackets. The number will turn into a hyperlink that brings readers to the appropriate footnote at the bottom of the page.

At the bottom of the page, write the same footnote construction (a caret followed by a number in brackets) then a colon. Any text written after that will appear in the footnote at the bottom of the page. In this example, our footnote is a hyperlink to an article in The Wall Street Journal.

This needs some evidence. [^1]

[^1]: See the work of Dr. Pepper for more information.

Print your own Markdown Cheat Sheet

If you find yourself forgetting how to do something in markdown, there are many markdown cheatsheets available on the web. Here is [one you can print out](https://guides.github.com/p
Clone this wiki locally