h1 Heading

h2 Heading

h3 Heading

h4 Heading

h5 Heading
h6 Heading

Text formatting

Text formatting can also be applied using Editing shortcuts.

Style Syntax Example Output
Bold ** ** or __ __ **Bold text** Bold text
Italic * * or _ _ *Italic text* Italic text
Strikethrough ~~ ~~ ~~Striked out text~~ Striked out text
Bold and nested italic ** ** and _ _ **Bold text and _nested italic_ text** Bold text and nested italic text
Bold and italic *** *** or ___ ___ ***Bold and italic text*** Bold and italic text

Formatting can be forced to display in plain text by adding a backslash \ in front of it.

This line will not be bold

\*\*This line will not be bold\*\*

This line will be italic and show the asterisks

\**This line will be italic and show the asterisks*\*

Marked/Highlight text

==Marked text==

Blockquotes

Blockquotes can also be nested...

...by using additional greater-than signs right next to each other...

...or with spaces between arrows.

Callout

You can turn your quote into a callout by adding [!info] as the first line in a quote.

[!info] Here's a callout title Here's a callout block. It supports Markdown, [[Internal link|Wikilinks]], and [[Embed files|embeds]]!

Foldable callouts

You can make a callout foldable by adding a plus (+) or a minus (-) directly after the type identifier.

A plus sign expands the callout by default, and a minus sign collapses it instead.

[!faq]- Are callouts foldable? Yes! In a foldable callout, the contents are hidden when the callout is collapsed.

Supported types

You can use several callout types and aliases. Each type comes with a different background color and icon.

  • abstract
  • info
  • todo
  • tip
  • success
  • question
  • warning
  • failure
  • danger
  • bug
  • example
  • quote

Unless you Customize callouts, any unsupported type defaults to the note type. The type identifier is case-insensitive.

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.

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));

Links

https://github.com/nodeca/pica

link text

link with title

Images

Minion Stormtroopocat

Like links, Images also have a footnote style syntax

Alt text

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

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.

← Back Edit