h1 Heading 8-) h2 Heading h3 Heading h4 Heading h5 Heading h6 Heading Horizontal Rules Typographic replacements Enable typographer option to see result. (c) (C) (r) (R) (tm) (TM) (p) (P) +- test.....
h1 Heading 8-)
h2 Heading
h3 Heading
h4 Heading
h5 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!....
!!!!!! ???? ,, -- ---
"Smartypants, double quotes" and 'single quotes'
Emphasis
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.
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
-
Lorem ipsum dolor sit amet
-
Consectetur adipiscing elit
-
Integer molestie lorem at massa
-
You can use sequential numbers...
-
...or keep all the numbers as 1.
Start numbering with offset:
- foo
- bar
Code
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code "fences"
Sample text here...
Syntax highlighting
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. |
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
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
Images
!Minion
<img src="https://octodex.github.com/images/stormtroopocat.jpg" alt="Stormtroopocat" title="The Stormtroopocat" />
Like links, Images also have a footnote style syntax
<img src="https://octodex.github.com/images/dojocat.jpg" alt="Alt text" title="The Dojocat" />
With a reference later in the document defining the URL location:
Plugins
The killer feature of markdown-it is very effective support of
syntax plugins.
Classic markup: :wink: :crush: :cry: :tear: :laughing: :yum:
Shortcuts (emoticons): :-) :-( 8-) ;)
see how to change output with twemoji.
++Inserted text++
==Marked text==
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.
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
This is HTML abbreviation example.
It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
*[HTML]: Hyper Text Markup Language
::: warning
here be dragons
:::
I made this! A full-resolution PNG is available over on DeviantArt for $2, but you can grab a nearly-full-resolution JPEG for free, here: https://i.imgur.com/Hjmo7U8.jpg
Previously I made a similar image of Jon Pertwee.