# Gitbook Markdown syntax

Contrast this page to:

* raw markdown: <https://raw.githubusercontent.com/audacity/audacity-support/main/community/contributing/tutorials/gitbook-markdown-syntax.md>&#x20;
* Github's markdown renderer: <https://github.com/audacity/audacity-support/blob/main/community/contributing/tutorials/gitbook-markdown-syntax.md>

## Heading 1&#x20;

(shows up in the outline)

### Heading 2&#x20;

(also shows up in the outline)

#### Heading 3&#x20;

(does not show up in the outline)

Headings can be used anywhere, including inside other blocks.

## Inline text formatting options

**Bold**,\
&#x20;*Italics*,\
`Code`, \
~~Strikethrough~~, \
[Link](https://example.org), \
[internal link](/~/changes/gvJiM3Yz1dG3uk35ImQU/community/contributing/tutorials/style-guide.md), \
[anchor link](#undefined), \
page link: [Style Guide](/~/changes/gvJiM3Yz1dG3uk35ImQU/community/contributing/tutorials/style-guide.md), \
page anchor link: [#inline-text-formatting-options](#inline-text-formatting-options "mention"), \ <mark style="color:red;">colored text</mark>, \ <mark style="background-color:green;">colored background</mark>, \ <mark style="color:yellow;background-color:blue;">both colored</mark>, \
LaTeX: $$f(x) = x \* e^{2 pi i \xi x}$$

These can be used anywhere.

## Lists

* Unordered
* List

1. Ordered
2. List

* [x] Task
* [ ] List

- List with
  1. sub-items
  2. can have
     * [x] 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&#x20;

Infoboxes:

{% hint style="info" %}
Hint
{% endhint %}

{% hint style="warning" %}
Caution
{% endhint %}

{% hint style="danger" %}
Danger
{% endhint %}

{% hint style="success" %}
Success
{% endhint %}

> A quote block

```
// a code block
```

```html
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: ![](/files/M7ixy9Gk8eOBWolk1ORt)

Image block:

![supports captions](/files/kSlPnDLd0yL0sTGZoGyi)

Attached file:

{% file src="/files/kSlPnDLd0yL0sTGZoGyi" %}
supports captions
{% endfile %}

## Embeds

{% embed url="<https://www.youtube.com/watch?v=HpA138b-J9s>" %}
YouTube embed
{% endembed %}

{% embed url="<https://audacityteam.org>" %}
Arbitrary website without player
{% endembed %}

{% embed url="<https://gist.github.com/LWinterberg/fbdfe97044af6fafc01f06862817babe>" %}
gist embed
{% endembed %}

{% embed url="<https://soundcloud.com/rick-astley-official/never-gonna-give-you-up-4>" %}
soundcloud embed
{% endembed %}

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

## Tables

<table><thead><tr><th data-type="checkbox">checkbox column</th><th align="center">text column, center-aligned</th><th data-type="number">number column</th><th data-hidden>hidden text column</th></tr></thead><tbody><tr><td>true</td><td align="center">text</td><td>123</td><td>hidden</td></tr><tr><td>false</td><td align="center">text</td><td>456</td><td>hidden</td></tr><tr><td>true</td><td align="center">text</td><td>789</td><td>hidden</td></tr></tbody></table>

<table><thead><tr><th>select-option column<select multiple><option value="64ea6801db7c43c08cea2bc65f0fe7d1" label="option a" color="blue"></option><option value="36387035f9e34215a942470ccfa8d781" label="option b" color="blue"></option><option value="0084b6cd834d4088bbd2188363ddf09a" label="option c" color="blue"></option></select></th><th data-type="files">files column</th><th data-type="rating" data-max="3">Ratings column</th></tr></thead><tbody><tr><td><span data-option="64ea6801db7c43c08cea2bc65f0fe7d1">option a</span></td><td><a href="/files/M7ixy9Gk8eOBWolk1ORt">/files/M7ixy9Gk8eOBWolk1ORt</a></td><td>3</td></tr><tr><td><span data-option="36387035f9e34215a942470ccfa8d781">option b</span></td><td><a href="/files/kSlPnDLd0yL0sTGZoGyi">/files/kSlPnDLd0yL0sTGZoGyi</a></td><td>2</td></tr><tr><td><span data-option="0084b6cd834d4088bbd2188363ddf09a">option c, </span><span data-option="36387035f9e34215a942470ccfa8d781">option b, </span><span data-option="64ea6801db7c43c08cea2bc65f0fe7d1">option a</span></td><td><a href="/files/M7ixy9Gk8eOBWolk1ORt">/files/M7ixy9Gk8eOBWolk1ORt</a><a href="/files/kSlPnDLd0yL0sTGZoGyi">/files/kSlPnDLd0yL0sTGZoGyi</a><a href="/files/KiaNr0eJioRPRmbt6Up2">/files/KiaNr0eJioRPRmbt6Up2</a></td><td>1</td></tr></tbody></table>

{% hint style="danger" %}
Select-option and files columns appear empty in Markdown. Avoid using them.
{% endhint %}

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

{% tabs %}
{% tab title="First Tab" %}
content of first tab
{% endtab %}

{% tab title="Second Tab" %}
content of second tab
{% endtab %}

{% tab title="Third tab" %}
content of third tab
{% endtab %}
{% endtabs %}

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)

<details>

<summary>Expandable title</summary>

Expandable content

</details>

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

## Drawings

<img src="/files/Z5KKQC62JnZD5HbK6sD4" alt="also supports captions" class="gitbook-drawing">

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

<mark style="color:blue;">`GET`</mark> `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<mark style="color:red;">\*</mark> | String | Description |

#### Headers

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | String | Description |

#### Cookies

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | String | Description |

#### Request Body

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | String | Description |

{% tabs %}
{% tab title="200: OK Description" %}

```javascript
{
    // good Response
}
```

{% endtab %}

{% tab title="404: Not Found Description" %}

```javascript
{
    // not found Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error Description" %}

```javascript
{
    // error Response
}
```

{% endtab %}
{% endtabs %}

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.audacityteam.org/~/changes/gvJiM3Yz1dG3uk35ImQU/community/contributing/tutorials/gitbook-markdown-syntax.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.