Skip to Content
Getting Started - RenameToolingPull Requests - Change

Last Updated: 3/7/2026


  1. h1 Heading 8-)

IDE

asddfsdf

h2 Head ing

h3 Heading asdf

h4 Heading

TESTTESTYTEST
TEasdfsadf
sadfafsddasf
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

  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:

  1. foo
  2. 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

OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.

Right aligned columns

OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.

link text 

link with title 

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

Images

Minion

Minion

Minion

Minion

Minion

Minion

Minion

Minion

Minion

Minion

Like links, Images also have a footnote style syntax

Alt text

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 .

Emojies 

Classic markup: 😉 😢 😆 😋

Shortcuts (emoticons): :-) :-( 8-) ;)

see how to change output  with twemoji.

Subscript  / Superscript 

  • 19^th^
  • H2O

ins> 

++Inserted text++

mark> 

==Marked text==

Footnotes 

Footnote 1 link1.

Footnote 2 link2.

Inline footnote^[Text of inline footnote] definition.

Duplicated footnote reference2.

and multiple paragraphs.

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

Abbreviations 

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 

::: warning
here be dragons
:::

Footnotes

  1. Footnote can have markup

  2. Footnote text. 2