MarkdownDox

Sample Markdown

Showing Markdown supported by MarkdownDox

Thanks to Markdown-It for providing the original sample content.

Table of Contents

[[toc]] produces the Table of Contents below.

Headings

# h1 Heading

h1 Heading

## h2 Heading

h2 Heading

### h3 Heading

h3 Heading

#### h4 Heading

h4 Heading

##### h5 Heading

h5 Heading

###### h6 Heading

h6 Heading

Horizontal Rules

___


---


***


Typographic replacements

Enable typographer option to see result.

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

© © ® ® ™ ™ § § ±

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

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

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

!!! ??? , – —

"Smartypants, double quotes" and 'single quotes'

“Smartypants, double quotes” and ‘single quotes’

Emphasis

**This is bold text**

This is bold text

__This is bold text__

This is bold text

*This is italic text*

This is italic text

~~Strikethrough~~

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
  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.`
  1. You can use sequential numbers…
  2. …or keep all the numbers as 1.

Start numbering with offset:

57. foo
1. bar
  1. foo
  2. bar

Code

Inline  `code`

Inline code

Indented code

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

Block code “fences”

```

Sample text here...

```


Sample text here...

Syntax highlighting

``` js

var foo = function (bar) {

return bar++;

};

console.log(foo(5));

```


var foo = function (bar) {

return bar++;

};

console.log(foo(5));

Tables

| 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. |
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. |
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.

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

link text

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

link with title

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

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

Images

![Minion](https://octodex.github.com/images/minion.png)

Minion

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

Stormtroopocat

Like links, Images also have a footnote style syntax

![Alt text][id]

Alt text

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

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

Plugins

The killer feature of markdown-it is very effective support of syntax plugins.

Emojies

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

Classic markup: 😉 :crush: 😢 :tear: 😆 😋

Shortcuts (emoticons): 😃 😦 😎 😉

see how to change output with twemoji.

Subscript / Superscript

- 19^th^
- H~2~O

<ins>

++Inserted text++

Inserted text

<mark>

==Marked text==

Marked text

Footnotes

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.

Footnote 1 link[1].

Footnote 2 link[2].

Inline footnote[3] definition.

Duplicated footnote reference[2:1].

Definition lists

Term 1

:   Definition 1
with lazy continuation.

Term 2 with *inline markup*

:   Definition 2

        { some code, part of Definition 2 }

    Third paragraph of definition 2.

_Compact style:_

Term 1
  ~ Definition 1

Term 2
  ~ Definition 2a
  ~ Definition 2b
Term 1

Definition 1 with lazy continuation.

Term 2 with inline markup

Definition 2

  { some code, part of Definition 2 }

Third paragraph of definition 2.

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.

*[HTML]: Hyper Text Markup Language

This is HTML abbreviation example.

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

Custom containers

Supported containers: warning, caution, danger, important, tip, info, note.

::: warning
**Warning**

*Here be dragons*
:::

Warning

Here be dragons

::: caution
**Caution**

Be careful!
:::

Caution

Be careful!

::: danger
**Danger**

Danger Will Robinson!
:::

Danger

Danger Will Robinson!

::: important
**Important**

This is important!
:::

Important

This is important!

::: tip
**Tip**

This is a tip.
:::

Tip

This is a tip.

::: info
**Information**

This supplies some information.
:::

Information

This supplies some information.

::: note
**Note**

Take note!
:::

Note

Take note!

Underlined text

_This is underlined text_

This is underlined text

Keystroke tags

[[Ctrl]] + [[B]] produces the output below.

Ctrl + B

Checkboxes

[ ] Unchecked

[x] Checked

MultiMarkdown Table

Add more control over the formatting of tables.

Markdown

|             |          Grouping           ||
First Header  | Second Header | Third Header |
 ------------ | :-----------: | -----------: |
Content       |          *Long Cell*        ||
Content       |   **Cell**    |         Cell |                                         
New section   |     More      |         Data |
And more      | With an escaped '\|'       ||
[Prototype table]                              

Output

Grouping
First Header Second Header Third Header
Content Long Cell
Content Cell Cell
New section More Data
And more With an escaped ‘|’
Prototype table

Lists and sentences over multiple lines.

Markdown


First header | Second header
-------------|---------------
List:        | More  \
- over       | data  \
- several    |       \
- lines      |

Output

First header Second header

List:

  • over
  • several
  • lines

More data

Decorate - add attributes, IDs and classes

Gives more control to how you display your content.

For example, if you assign a small class to an image, you can then set the style in your stylesheet, so that all images with class="small" have a maximum width of 200 pixels.

Note: You will need to add the required class styling to your stylesheet for decorations to work.

Markdown

Red text <!--{.red}-->

Output

Red text

Style

.red{
    color: Red;
}

Markdown

![Minion](https://octodex.github.com/images/minion.png) <!--{.small}-->

Output

Minion

Style

img.small{
    max-width: 200px;
}

  1. Footnote can have markup

    and multiple paragraphs. ↩︎

  2. Footnote text. ↩︎ ↩︎

  3. Text of inline footnote ↩︎