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.
Last updated
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.
Last updated
© Muse Group & contributors. Contents licensed under the Creative Commons-Attribution 4.0 license.
Contrast this page to:
(shows up in the outline)
(also shows up in the outline)
(does not show up in the outline)
Headings can be used anywhere, including inside other blocks.
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:
These can be used anywhere.
Unordered
List
Ordered
List
List with
sub-items
can have
...
Lists can be used anywhere, including inside other blocks. They can only include inline content and other (nested) lists.
Infoboxes:
Hint
Caution
Danger
Success
A quote block
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.
Image block:
Attached file:
Embeds cannot be used inside of other blocks except the Tabs block, nor can other blocks be placed inside them.
text
text
text
Any table but the most simple option will be converted into HTML, rather than markdown when edited through gitbook.
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.
Cards and tables can be converted into each other.
content of first tab
Tabs cannot be used inside other blocks. Tabs can have most other blocks inside them, except of other tabs, expandables, and API blocks.
Expandables cannot be inside other blocks. Expandables can have headings, lists, code blocks, and inline content inside them.
A Gitbook-specific drawing thing, generating SVGs. Likely useless when using Markdown.
Cannot be placed inside of other blocks except the Tabs block. That said, an inline variant is available which can go pretty much anywhere.
GET https://example.com/example
shows itself up in the outline. Example of all available parameters follows:
id
String
Description
id*
String
Description
id
String
Description
id
String
Description
id
String
Description
Cannot be used inside other blocks. Can only contain plain text. Unfortunately very tailored towards web APIs only.
The above line is a divider.
Inline image:
Card 3 top. With inline formatting.
Card 3 mid
Card 3 bottom
Card 2 top. Entire card links to a page.
Card 2 mid
Card 2 bottom
Card 1 top. Card has an image on top.
Card 1 mid
Card 1 bottom
ZoomIn.png
transport toolbar.png
Trim.png