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. Ordered

  2. List

  • List with

    1. sub-items

    2. can have

  • ...

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

Image block:

Attached file:

Embeds

Embeds cannot be used inside of other blocks except the Tabs block, nor can other blocks be placed inside them.

Tables

checkbox columntext column, center-alignednumber column

text

123

text

456

text

789

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

Cards and tables can be converted into each other.

Tabs

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.

Expandable (Details block)

Expandable title

Expandable content

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

Drawings

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

API title

GET https://example.com/example

shows itself up in the outline. Example of all available parameters follows:

Path Parameters

NameTypeDescription

id

String

Description

Query Parameters

NameTypeDescription

id*

String

Description

Headers

NameTypeDescription

id

String

Description

Cookies

NameTypeDescription

id

String

Description

Request Body

NameTypeDescription

id

String

Description

{
    // good Response
}

Cannot be used inside other blocks. Can only contain plain text. Unfortunately very tailored towards web APIs only.

Dividers


The above line is a divider.

Last updated

Logo

Ā© Muse Group & contributors. Contents licensed under the Creative Commons-Attribution 4.0 license.