All pages
Powered by GitBook
1 of 1

Loading...

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, , , , page link: , page anchor link: , colored text, colored background, both colored, LaTeX:

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

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:

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 column
text column, center-aligned
number column
select-option column
files column
Ratings column

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

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

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

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

Query Parameters

Name
Type
Description

Headers

Name
Type
Description

Cookies

Name
Type
Description

Request Body

Name
Type
Description

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.

changing list styles
  • ...

  • f(x)=x∗e2piiξxf(x) = x * e^{2 pi i \xi x}f(x)=x∗e2piiξx

    text

    123

    text

    456

    text

    789
    option a
    option b
    option coption boption a
    f(x)=x∗e2piiξxf(x) = x * e^{2 pi i \xi x}f(x)=x∗e2piiξx

    id

    String

    Description

    id*

    String

    Description

    id

    String

    Description

    id

    String

    Description

    id

    String

    Description

    Link
    internal link
    anchor link
    Style Guide
    2KB
    transport toolbar.png
    image
    Open
    supports captions
    Drawing
    also supports captions
    supports captions
    ZoomIn.pngZoomIn.png
    transport toolbar.pngtransport toolbar.png
    ZoomIn.pngZoomIn.pngtransport toolbar.pngtransport toolbar.pngTrim.pngTrim.png
    Cover

    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

    Inline text formatting options
    // a code block
    code blocks <b style="some_css: 23px;" class="and other things"> also supports syntax highlighting</b>
    {
        // good Response
    }
    {
        // not found Response
    }
    {
        // error Response
    }
    Audacity ® | Free Audio editor, recorder, music making and more!audacityteam.org
    Arbitrary website without player
    YouTube embed
    Logo
    soundcloud embed
    gist embed