# Documenting
# h1 Heading 😎
# 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
- Marker character change forces new list start:
- 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 with title (opens new window)
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
# Images
Like links, Images also have a footnote style syntax
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 (opens new window).
# Emojies (opens new window)
Classic markup: 😉 :crush: 😢 :tear: 😆 😋
Shortcuts (emoticons): 😃 😦 😎 😉
see how to change output (opens new window) with twemoji.
# Subscript (opens new window) / Superscript (opens new window)
- 19^th^
- H~2~O
# <ins> (opens new window)
++Inserted text++
# <mark> (opens new window)
==Marked text==
# Footnotes (opens new window)
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.
# Definition lists (opens new window)
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 (opens new window)
This is HTML abbreviation example.
It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
*[HTML]: Hyper Text Markup Language
# Custom containers (opens new window)
TIP
here be tip
WARNING
here be dragons
DANGER
here be danger
Summary
Detail
# Badge
TIP WARNING ERROR# Code Highlighting
asset-demo
|- package.json
|- package-lock.json
|- speedy.config.ts
|- /dist
|- bundle.js
|- index.html
|- /src
+ |- style.css
|- index.js
|- /node_modules