Gitbook Markdown syntax
A page showing the Markdown for all the basic and fancy options there are. Also compares it to Github's Markdown. This block is the page description.
Contrast this page to:

Heading 1

(shows up in the outline)

Heading 2

(also shows up in the outline)

Heading 3

(does not show up in the outline)
Headings can be used anywhere, including inside other blocks.

Inline text formatting options

Bold, Italics, Code, Strikethrough, Link, internal link, anchor link, page link: Style Guide, page anchor link: Inline text formatting options, colored text, colored background, both colored, LaTeX:
f(x)=x∗e2piiξxf(x) = x * e^{2 pi i \xi x}
​
These can be used anywhere.

Lists

  • Unordered
  • List
  1. 1.
    Ordered
  2. 2.
    List
  • Task
  • List
  • List with
    1. 1.
      sub-items
    2. 2.
      can have
      • changing list styles
  • ...
Lists can be used anywhere, including inside other blocks. They can only include inline content and other (nested) lists.

Infoboxes, quotes and code blocks

Infoboxes:
Hint
Caution
Danger
Success
A quote block
// a code block
code blocks <b style="some_css: 23px;" class="and other things"> also supports syntax highlighting</b>
These blocks can be used inside of Tabs. The code block can also be used in Expandables, but cannot have other blocks inside it. The quote block and infobox can have headings, inline content and lists inside it.

Images and files

Inline image:
​
Image block:
supports captions
Attached file:
transport toolbar.png
2KB
Image
supports captions

Embeds

YouTube embed
Home
Audacity ®
Arbitrary website without player
gist embed
soundcloud embed
Embeds cannot be used inside of other blocks except the Tabs block, nor can other blocks be placed inside them.

Tables

checkbox column
text column, center-aligned
number column
text
123
text
456
text
789
select-option column
files column
Ratings column
option a
ZoomIn.png
option b
transport toolbar.png
option c
option b
option a
ZoomIn.png
transport toolbar.png
Trim.png
Select-option and files columns appear empty in Markdown. Avoid using them.
Tables cannot be used inside other blocks except the Tabs block, nor can other blocks be placed inside them. Inline content works inside of text columns only.

Tabs

First Tab
Second Tab
Third tab
content of first tab
content of second tab
content of third tab
Tabs cannot be used inside other blocks. Tabs can have most other blocks inside them, except of other tabs, expandables, and API blocks.

Expandable (Details block)

Expandable title
Expandables cannot be inside other blocks. Expandables can have headings, lists, code blocks, and inline content inside them.

Drawings

also supports captions
A Gitbook-specific drawing thing, generating SVGs. Likely useless when using Markdown.

LaTeX

f(x)=x∗e2piiξxf(x) = x * e^{2 pi i \xi x}
Cannot be placed inside of other blocks except the Tabs block. That said, an inline variant is available which can go pretty much anywhere.

Web API methods

get
https://example.com
/example
API title
Cannot be used inside other blocks. Can only contain plain text. Unfortunately very tailored towards web APIs only.
​
​
​
Export as PDF
Copy link
Edit on GitHub
On this page
Heading 1
Heading 2
Inline text formatting options
Lists
Infoboxes, quotes and code blocks
Images and files
Embeds
Tables
Tabs
Expandable (Details block)
Drawings
LaTeX
Web API methods
get
API title