Markdown

kc@example.com (kc kim) — Mon, 25 Dec 2017 19:03:07 +0900

Overview

Markdown is a text-based markup language used for README files, online documentation, and documents edited with plain text editors. Markdown documents can be converted to HTML and other formats. John Gruber created Markdown in 2004 to provide an easy-to-read and easy-to-write plain text format.

The logo was created by Dustin Curtis.

Syntax

Headers

Use one to six hash signs (#) for headings.

# H1
## H2
### H3

Block Quotes

Use > for quoted text.

> This is a blockquote.

Lists

Use *, +, or - for unordered lists and numbers for ordered lists.

- one
- two

1. one
2. two

Horizontal Rules

Use three or more hyphens, asterisks, or underscores.

***

Emphasis

*italic*
**bold**
~~strikethrough~~

Links and Images

[Google](https://www.google.com)
![Alt text](/logo/64x64.png "Optional title")

Inline Code and Code Blocks

Use backticks for inline code. Use three backticks for fenced code blocks.

`code`

```java
String str = "this is a code block";
```

Backslash Escapes

Use a backslash to display Markdown punctuation literally.

\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   hyphen
.   dot
!   exclamation mark

Extended Syntax

Footnotes

Footnotes are not part of the original Markdown specification, but many extended Markdown implementations support them.

This is a footnote reference.[^footnote]

[^footnote]: This is the footnote.

Reference

How to add footnotes to GitHub-flavoured Markdown? | Stack Overflow

devkuma – Markdown