Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed
https://markdown-it.github.io/
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
221 lines
3.6 KiB
221 lines
3.6 KiB
10 years ago
|
---
|
||
|
__Advertisement :)__
|
||
|
|
||
10 years ago
|
- __[pica](https://nodeca.github.io/pica/demo/)__ - high quality and fast image
|
||
10 years ago
|
resize in browser.
|
||
10 years ago
|
- __[babelfish](https://github.com/nodeca/babelfish/)__ - developer friendly
|
||
10 years ago
|
i18n with plurals support and easy syntax.
|
||
10 years ago
|
|
||
10 years ago
|
You will like those projects!
|
||
|
|
||
|
---
|
||
|
|
||
10 years ago
|
# h1 Heading
|
||
|
## h2 Heading
|
||
|
### h3 Heading
|
||
|
#### h4 Heading
|
||
|
##### h5 Heading
|
||
|
###### h6 Heading
|
||
|
|
||
|
|
||
|
## Horizontal Rules
|
||
|
|
||
|
___
|
||
|
|
||
|
---
|
||
|
|
||
|
***
|
||
|
|
||
|
|
||
10 years ago
|
## Typographic replacements
|
||
10 years ago
|
|
||
10 years ago
|
Enable typographer option to see result.
|
||
10 years ago
|
|
||
10 years ago
|
(c) (C) (r) (R) (tm) (TM) (p) (P) +-
|
||
10 years ago
|
|
||
10 years ago
|
test.. test... test..... test?..... test!....
|
||
10 years ago
|
|
||
10 years ago
|
!!!!!! ???? ,,
|
||
10 years ago
|
|
||
10 years ago
|
markdown-it -- awesome
|
||
10 years ago
|
|
||
10 years ago
|
"Smartypants, double quotes"
|
||
|
|
||
|
'Smartypants, single quotes'
|
||
|
|
||
10 years ago
|
|
||
|
## Emphasis
|
||
|
|
||
10 years ago
|
**This is bold text**
|
||
10 years ago
|
|
||
10 years ago
|
__This is bold text__
|
||
10 years ago
|
|
||
10 years ago
|
*This is italic text*
|
||
10 years ago
|
|
||
10 years ago
|
_This is italic text_
|
||
10 years ago
|
|
||
10 years ago
|
~~Deleted text~~
|
||
10 years ago
|
|
||
10 years ago
|
Superscript: 19^th^
|
||
|
|
||
|
Subscript: H~2~O
|
||
|
|
||
10 years ago
|
++Inserted text++
|
||
|
|
||
10 years ago
|
==Marked text==
|
||
|
|
||
10 years ago
|
|
||
|
## Blockquotes
|
||
|
|
||
|
|
||
10 years ago
|
> Blockquotes can also be nested...
|
||
|
>> ...by using additional greater-than signs right next to each other...
|
||
|
> > > ...or with spaces between arrows.
|
||
10 years ago
|
|
||
|
|
||
|
## Lists
|
||
|
|
||
10 years ago
|
Unordered
|
||
10 years ago
|
|
||
10 years ago
|
+ Create a list by starting a line with `+`, `-`, or `*`
|
||
|
+ Sub-lists are made by indenting 2 spaces:
|
||
10 years ago
|
- Marker character change forces new list start:
|
||
10 years ago
|
* Ac tristique libero volutpat at
|
||
|
+ Facilisis in pretium nisl aliquet
|
||
|
- Nulla volutpat aliquam velit
|
||
|
+ Very easy!
|
||
10 years ago
|
|
||
10 years ago
|
Ordered
|
||
10 years ago
|
|
||
|
1. Lorem ipsum dolor sit amet
|
||
|
2. Consectetur adipiscing elit
|
||
|
3. Integer molestie lorem at massa
|
||
10 years ago
|
|
||
10 years ago
|
|
||
10 years ago
|
1. You can use sequential numbers...
|
||
|
1. ...or keep all the numbers as `1.`
|
||
10 years ago
|
|
||
10 years ago
|
Start numbering with offset:
|
||
|
|
||
|
57. foo
|
||
|
1. bar
|
||
|
|
||
10 years ago
|
|
||
|
## Code
|
||
|
|
||
10 years ago
|
Inline `code`
|
||
10 years ago
|
|
||
10 years ago
|
Indented code
|
||
10 years ago
|
|
||
|
// Some comments
|
||
|
line 1 of code
|
||
|
line 2 of code
|
||
|
line 3 of code
|
||
|
|
||
|
|
||
10 years ago
|
Block code "fences"
|
||
10 years ago
|
|
||
|
```
|
||
|
Sample text here...
|
||
|
```
|
||
|
|
||
10 years ago
|
Syntax highlighting
|
||
10 years ago
|
|
||
10 years ago
|
``` js
|
||
10 years ago
|
var foo = function (bar) {
|
||
|
return bar++;
|
||
10 years ago
|
};
|
||
10 years ago
|
|
||
|
console.log(foo(5));
|
||
10 years ago
|
```
|
||
|
|
||
|
## 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. |
|
||
|
|
||
10 years ago
|
Right aligned columns
|
||
10 years ago
|
|
||
|
| 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
|
||
|
|
||
10 years ago
|
[link text](http://dev.nodeca.com)
|
||
10 years ago
|
|
||
10 years ago
|
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
|
||
10 years ago
|
|
||
10 years ago
|
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
|
||
10 years ago
|
|
||
|
|
||
|
## Images
|
||
|
|
||
10 years ago
|
![Minion](https://octodex.github.com/images/minion.png)
|
||
|
![Stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
|
||
10 years ago
|
|
||
|
Like links, Images also have a footnote style syntax
|
||
|
|
||
|
![Alt text][id]
|
||
|
|
||
|
With a reference later in the document defining the URL location:
|
||
|
|
||
10 years ago
|
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
||
10 years ago
|
|
||
|
|
||
10 years ago
|
## Footnotes
|
||
10 years ago
|
|
||
10 years ago
|
Footnote 1 link[^first].
|
||
10 years ago
|
|
||
10 years ago
|
Footnote 2 link[^second].
|
||
10 years ago
|
|
||
10 years ago
|
Inline footnote^[Text of inline footnote] definition.
|
||
10 years ago
|
|
||
10 years ago
|
Duplicated footnote reference[^second].
|
||
10 years ago
|
|
||
10 years ago
|
[^first]: Footnote **can have markup**
|
||
10 years ago
|
|
||
10 years ago
|
and multiple paragraphs.
|
||
10 years ago
|
|
||
10 years ago
|
[^second]: Footnote text.
|
||
10 years ago
|
|
||
10 years ago
|
|
||
|
## 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
|
||
|
|
||
|
|
||
10 years ago
|
## Abbreviations
|
||
10 years ago
|
|
||
10 years ago
|
This is HTML abbreviation example.
|
||
|
|
||
|
It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
|
||
|
|
||
|
*[HTML]: Hyper Text Markup Language
|