Markdown Notation Samples
Headings
Describe a heading with one to six sharps. A single space should be placed between each sharp and the heading character.
Example
## Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Example Display
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Bulleted list
Bulleted lists can be described with a hyphen, plus or asterisk. A single space between the hyphen, plus, or asterisk and the bulleted item.
Example
- List 1
- Nest List 1_1
- Nest List 1 List 1_1_1
- nest list 1_1_2
- nest list1_2 nest list1_2
- List 2
- List 2 List 3
Example Display
- List 1
- Nest List 1_1
- Nest List 1_1_1
- Nest List 1_1_2
- Listing 1 nested Listing 1_2 nested Listing 2 nested Listing 3 nested Listing 4 nested Listing 5
- Nest List 1_1
- List 2
- List 2 List 3
Numbered lists
Numbered lists can be described by numbers + one-byte dots. The content of the number can be anything. The numbering can be anything, but it will be displayed with the appropriate number when it is actually displayed. Therefore, in general, it is easier and stronger to change if all items are described with 1. contents. *A single space should be inserted between the number + one-byte dot and the bulleted item.
Example of description
1. numbered list 1
numbered list1_1 1. numbered list1_1
Numbered List 1_2 1.
Numbered List 2
Numbered List 3
Example Display
Numbered List 1 Numbered List 1_1 Numbered List 1_2 1. Numbered List 2 Numbered List 3
Citation
Example Description
> Thank you for your business, my name is xxx.
>
> > Thank you very much for your help.
Example display
Thank you very much for your help.
Thank you very much for your help.
Double quotes.
Example
> Thank you very much for your help.
> > Thanks for your help.
> > Thanks for your help.
>> Thank you for your help. yyyy.
>>
>> That new feature is buggy.
Example display
Thanks for your help, my name is xxx.
Thank you very much for your help. Thank you for your help. This is yyyy.
That new feature is buggy.
pre notation (4 spaces or tab)
You can pre-display a code block with 4 spaces or a tab.
Example
# Tab
class Hoge
def hoge
print 'hoge'
end
end
---end
# Space
class Hoge
def hoge
print 'hoge'
end
end
Example Display
# Tab
class Hoge
def hoge
print 'hoge'
end
end
—end
# Space
class Hoge
def hoge
print 'hoge'
end
end
code notation
It is possible to display a portion of the code by enclosing the string in back quotes.
Example
Install command is `gem install hoge`
Example Display
Install command gem install hoge
Emphasis added:<em>
Emphasis is added by enclosing the string with an asterisk or single underscore. The appearance will be italicized.
Example
normal *italic* normal
normal _italic_ normal
Example Display
normal italic normal normal italic normal
Emphasis added:<strong>
Surround the string with an asterisk or two underscores for emphasis. The appearance will be bold.
Example
normal **bold** normal
normal __bold__ normal
Example Display
normal bold normal normal bold normal
Emphasis added:<em> + <strong>
Enclose the string with an asterisk or three underscores to apply both <em> and <strong> emphasis.
The text will look italicized and bold.
Example
normal ***bold*** normal
normal ___bold___ normal
Example Display
normal bold normal normal bold normal
horizontal line
Horizontal lines are indicated by three or more consecutive underscores, asterisks, hyphens, etc. *A space between consecutive hyphens, etc. is acceptable.
Example
***
___
---
* * *
Example Display
Link
You can describe a link in the form of [display character](link URL)
Example
[Google Docs](https://www.google.com/)
Example of display
Definition reference link
If you do not want to write a long link in the middle of a Markdown document, If you want to use the same link reference many times, you can define a reference to the link.
Example description.
[google from here][google][google].
Other text
[google from here][google].
[google]: https://www.google.com/
Example display
google from heregoogle. Other text googlegoogle.
GitHub Flavored Markdown (GFM)
GitHub Flavored Markdown (GFM) is a Markdown notation with GitHub’s own specifications added. It is hereafter referred to as GFM.
GFM:Linked text simple notation
URLs are automatically converted to links by simply writing them.
Example
https://www.google.com/
Display example
GFM: Strikethrough
You can use a strikeout line by enclosing a string with two tildes.
Example
~~Strikeout~~
Example of display
Strikeout
GFM:pre notation (tilde x 3)
Example description
~~~
class Hoge
def hoge
print 'hoge'
end
end
~~~
Example Display
class Hoge
def hoge
print 'hoge'
end
end
GFM:pre notation (backquotes x3)
Example
```` class Hoge
class Hoge
def hoge
print 'hoge'
end
end
```
Example display
class Hoge
def hoge
print 'hoge'
end
end
*If you continue to use pre notation, separate the types
GFM:pre notation (syntax highlighting)
The language name of the target syntax is written after the tilde or three back-quotes.
Example
~~~ruby
class Hoge
def hoge
print 'hoge'
end
end
~~~
example display
class Hoge
def hoge
print 'hoge'
end
end
GFM:Table
Example
|header1|header2|header3|
|:--||--:|:--:|
|align left|align right|align center|
|a|b|c|
Example of display
| header1 | header2 | header3 |
|---|---|---|
| align left | align right | align center |
| a | b | c |
GFM:Link in page
With GitHub’s Markdown, when you use the heading notation Anchors are automatically created when you use the heading notation. You can easily create links within a page using those anchors.
Example
## menu
* [to header1](#header1)
* [to header2](#header2)
<! -- some long code -->
[return to menu](#menu)
### header1
### header2
The HTML is a little abbreviated, but it will look something like this.
Example Display
<h2><a name="user-content-menu" href="#menu">menu</a></h2>
<a href="#header1">to header1</a>
<a href="#header2">to header2</a>
<! -- some long code -->
<a href="#menu">to menu</a>
<h3><a name="user-content-header1" href="#header1">header1</a></h3>
<h3><a name="user-content-header2" href="#header2">header2</a></h3>