Formatting Examples

Table of Contents

[toc]

Headings

# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading

Typography

Subscript / Superscript

• 19^th
• H₂O

- 19^th^
- H~2~O

<ins>

Inserted text

++Inserted text++

Footnotes

Footnote 1 link^[1].

Footnote 2 link^[2].

Inline footnote^[3] definition.

Duplicated footnote reference^[2:1].

Footnote 1 link[^first].

Footnote 2 link[^second].

Inline footnote^[Text of inline footnote] definition.

Duplicated footnote reference[^second].

[^first]: Footnote **can have markup**

    and multiple paragraphs.

[^second]: Footnote text.

<mark>

Marked text

==Marked text==

Keyboard Input Element

↑↑↓↓←→←→BA ; sometimes Start or Select is added to the sequence.

[[↑]][[↑]][[↓]][[↓]][[←]][[→]][[←]][[→]][[B]][[A]] ; sometimes [[Start]] or [[Select]] is added to the sequence.

Attributes

paragraph style me more text

paragraph *style me*{.u-txtRed} more text

Typographic replacements

Enable typographer option to see result.

© © ® ® ™ ™ (p) (P) ±

test… test… test… test?.. test!..

!!! ??? , – —

“Smartypants, double quotes” and ‘single quotes’

Enable typographer option to see result.

(c) (C) (r) (R) (tm) (TM) (p) (P) +-

test.. test... test..... test?..... test!....

!!!!!! ???? ,,  -- ---

"Smartypants, double quotes" and 'single quotes'

Emojis

Classic markup: 😉 😢 😆 😋

Shortcuts (emoticons): 😃 😦 😎 😉

> Classic markup: :wink: :cry: :laughing: :yum:
>
> Shortcuts (emoticons): :-) :-( 8-) ;)

see how to change output with twemoji.

Emphasis

This is bold text

This is bold text

This is italic text

This is italic text

Strikethrough

**This is bold text**

__This is bold text__

*This is italic text*

_This is italic text_

~~Strikethrough~~

Blockquotes

Blockquotes can also be nested…

…by using additional greater-than signs right next to each other…

…or with spaces between arrows.

> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.

Lists

Unordered

• Create a list by starting a line with +, -, or *
• Sub-lists are made by indenting 2 spaces:
  • Marker character change forces new list start:
    • Ac tristique libero volutpat at
    • Facilisis in pretium nisl aliquet
    • Nulla volutpat aliquam velit
• Very easy!

Ordered

1. Lorem ipsum dolor sit amet

2. Consectetur adipiscing elit

3. Integer molestie lorem at massa

4. You can use sequential numbers…

5. …or keep all the numbers as 1.

Start numbering with offset:

57. foo
58. bar

Checkbox List (Unordered)

• List Item 1 unchecked
• List Item 2 checked
• List Item 3 checked
  • Sub List Item 1 unchecked
  • Sub List Item 1 checked

Unordered

+ Create a list by starting a line with `+`, `-`, or `*`
+ Sub-lists are made by indenting 2 spaces:
  - Marker character change forces new list start:
    * Ac tristique libero volutpat at
    + Facilisis in pretium nisl aliquet
    - Nulla volutpat aliquam velit
+ Very easy!

Ordered

1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa


1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`

Start numbering with offset:

57. foo
1. bar

Checkbox List (Unordered)

- [ ] List Item 1 unchecked
- [x] List Item 2 checked
- [x] List Item 3 checked
  - [ ] Sub List Item 1 unchecked
  - [x] Sub List Item 1 checked

Code

Inline code

Indented code

// Some comments
line 1 of code
line 2 of code
line 3 of code

Named code block fences

console.log("Hello World!")
hello.js

Block code “fences”

Sample text here...

Syntax highlighting

var foo = function (bar) {
  return bar++;
};

console.log(foo(5));

Syntax highlighting

var foo = function (bar) {
  return bar++;
};

console.log(foo(5));

Tables

Right aligned columns

| Option | Description |
| ------ | ----------- |
| data   | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext    | extension to be used for dest files. |

Right aligned columns

| Option | Description |
| ------:| -----------:|
| data   | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext    | extension to be used for dest files. |

Links

link text

link with title

text with non-external link

Autoconverted link https://github.com/nodeca/pica (enable linkify to see)

[link text](http://dev.nodeca.com)

[link with title](http://nodeca.github.io/pica/demo/ "title text!")

[text with non-external link](/)

Autoconverted link https://github.com/nodeca/pica (enable linkify to see)

Images

![Minion](https://octodex.github.com/images/minion.png)
![Stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")

Like links, Images also have a footnote style syntax

With a reference later in the document defining the URL location:

![Alt text][id]

With a reference later in the document defining the URL location:

[id]: https://octodex.github.com/images/dojocat.jpg  "The Dojocat"

Horizontal Rules

___

---

***

Media/Embed

Provided by the newest fork of markdown-it-video so far.
Using plain HTML for embeds works too.

Local Video

@[video](/media/Big-buck-bunny_trailer.webm)

Local Audio

@[audio](/media/Title Screen JP Version - Sonic the Hedgehog.mp3)

YouTube Embed

@[youtube](9bZkp7q19f0)

More options here…

Miscelleneous

markdown-it has support for various syntax plugins.

Custom containers

::: warning
*here be dragons*
:::

Note: The plugin requires adding definition for each type of container you need in config like ‘warning’.

Definition lists

Term 1

Definition 1
with lazy continuation.

Compact style:

Term 1

Definition 1

Term 2

Definition 2a

Definition 2b

_Compact style:_

Term 1
  ~ Definition 1

Term 2
  ~ Definition 2a
  ~ Definition 2b

Abbreviations

This is HTML abbreviation example.

It converts “HTML”, but keep intact partial entries like “xxxHTMLyyy” and so on.

This is HTML abbreviation example.

It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.

*[HTML]: Hyper Text Markup Language

Summary/Legend

+++ Click me!
Hidden text
+++