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:

• raw markdown: https://raw.githubusercontent.com/audacity/audacity-support/main/community/contributing/tutorials/gitbook-markdown-syntax.md

• Github's markdown renderer: https://github.com/audacity/audacity-support/blob/main/community/contributing/tutorials/gitbook-markdown-syntax.md

• the live page: https://support.audacityteam.org/community/contributing/tutorials/gitbook-markdown-syntax

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 * e^{2 pi i \xi x}$

These can be used anywhere.

Lists

• Unordered

• List

1. Ordered

2. List

• Task

• List

• List with

  1. sub-items

  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:

2KB

transport toolbar.png

image

Embeds

YouTube embed

HomeAudacity ®

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 coption boption a	ZoomIn.pngtransport toolbar.pngTrim.png

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

Card 1 top. Card has an image on top.

Card 1 mid

Card 1 bottom

Card 2 top. Entire card links to a page.

Card 2 mid

Card 2 bottom

Card 3 top. With inline formatting.

Card 3 mid

Card 3 bottom

Cards and tables can be converted into each other.

Tabs

First Tab

content of first tab

Second Tab

content of second tab

Third 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

Expandable content

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 * 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

Name	Type	Description
id	String	Description

Query Parameters

Name	Type	Description
id*	String	Description

Headers

Name	Type	Description
id	String	Description

Cookies

Name	Type	Description
id	String	Description

Request Body

Name	Type	Description
id	String	Description

200: OK Description

{
    // good Response
}

404: Not Found Description

{
    // not found Response
}

500: Internal Server Error Description

{
    // error 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.