Audacity Support
  • Audacity Support
  • Audacity Basics
    • Downloading & installing Audacity
    • Installing FFmpeg
    • Recording your voice with a microphone
      • Setting recording and playback levels
    • Recording desktop audio
    • Editing audio
    • Saving and exporting projects
    • ☁️Sharing audio online
    • Customizing Audacity
      • Using themes
      • Installing plugins
      • Effect Presets
    • Keyboard shortcuts
  • Repairing Audio Recordings
    • Noise reduction & removal
    • Re-recording a section
    • Removing clicks & pops
  • Audio Editing
    • 🆕Using master effects & realtime effects
    • Making crossfades
    • Speeding up and slowing down audio
    • Changing pitch
    • Mixing and panning tracks
    • 🆕Reducing dynamic range (Compressor / Limiter)
    • Splitting a recording into separate tracks
    • Loudness Normalization
    • Macros
      • Manage Macros
      • Macros Palette
      • Macros Examples
    • Audiobook Mastering
  • Music
    • 🆕Enabling music view
    • Aligning music to beats and bars
    • Working with audio loops
      • Making audio loops
    • Isolating or removing vocals from a song
  • Audio Analysis
    • Spectral analysis
  • Troubleshooting
    • Troubleshooting overview
    • Error codes
      • Error -9996: Invalid Device Error
      • Error -9997: Invalid Sample Rate
      • Error -9998: Invalid number of channels
      • Error -9999: Unanticipated Host Error
      • Error opening sound device
      • Error opening recording device
      • Error: Audacity failed to read a file in C: and Error: Failed to Open Database File
      • Error Audacity did not recognize the type of this file
      • Error: The Audacity IPC server failed to initialize
      • Error code=12: cannot allocate memory (macOS)
      • Error: Missing Plugins
      • Error FFmpeg:1008
      • Installation exit codes
    • Recovering corrupted projects
      • Recovering corrupted projects in legacy Audacity versions
    • Common troubleshooting steps
    • Solving recording problems
      • Audacity is not detecting the audio device I just connected
      • Audacity is not playing back what is being recorded
      • Delay and echoes when recording
      • Crackles, pops and distortion in the recording
      • Vertical red lines in the recording
      • Recording volume slider cannot be moved
      • Audacity records silence when using a Bluetooth headset as a recording device
      • Only the left channel is recording
      • Recording dropouts, gaps, skips and glitches
      • Latency Compensation
    • Solving other problems
    • Resetting Audacity
    • Uninstalling OpenVINO models
    • Missing features
  • Special uses
    • Info for Visually Impaired Users
    • Info for System Administrators
  • Community
    • Contributing to Audacity
      • Making Tutorials and User Guides
        • Style Guide
        • Editing through GitHub
        • Gitbook Markdown syntax
        • TODO
          • Untitled
          • ASIO in Audacity
          • Synchronizing Tracks
            • Keeping Tracks Synchronized
          • Using Macros to Automate Frequent Tasks
          • Using looping Playback
          • Mastering for Audio Books
          • How to use Audacity
          • Working with Tracks
      • Developing Audacity
      • Translating Audacity
      • Answering user questions
      • Testing the latest features
      • Finding & testing plugins
      • Credits & License
    • 💬Discord
    • 💬Forum
  • Additional resources
    • 📄Changelog
      • Audacity 3.7
      • Audacity 3.7.1
      • Audacity 3.7.2
      • Audacity 3.7.3
      • Audacity 3.7.4
      • Older versions
        • Audacity 1.x
        • Audacity 2.x
          • Audacity 2.0.0
            • Audacity 2.0.1
            • Audacity 2.0.2
            • Audacity 2.0.3
            • Audacity 2.0.4
            • Audacity 2.0.5
            • Audacity 2.0.6
          • Audacity 2.1.0
            • Audacity 2.1.1
            • Audacity 2.1.2
            • Audacity 2.1.3
              • New features in Audacity 2.1.3
              • New features in Audacity 2.1.3 - Appendix
          • Audacity 2.2.0
            • New features in Audacity 2.2.0
            • New features in Audacity 2.2.0 - Appendix
            • Audacity 2.2.1
              • New features in Audacity 2.2.1
            • Audacity 2.2.2
              • New features in Audacity 2.2.2
          • Audacity 2.3.0
            • New features in Audacity 2.3.0
            • Audacity 2.3.1
              • New features in Audacity 2.3.1
            • Audacity 2.3.2
              • New features in Audacity 2.3.2
            • Audacity 2.3.3
              • New features in Audacity 2.3.3
          • Audacity 2.4.0
            • New features in Audacity 2.4.0
            • Audacity 2.4.1
              • New features in Audacity 2.4.1
            • Audacity 2.4.2
              • New features in Audacity 2.4.2
        • Audacity 3.0
          • New features in Audacity 3.0.0
          • Audacity 3.0.2
            • New features in Audacity 3.0.2
          • Audacity 3.0.3
            • New features in Audacity 3.0.3
          • Audacity 3.0.4
            • New features in Audacity 3.0.4
          • Audacity 3.0.5
        • Audacity 3.1
          • Audacity 3.1.1
          • Audacity 3.1.2
          • Audacity 3.1.3
        • Audacity 3.2
          • Audacity 3.2.1
          • Audacity 3.2.2
          • Audacity 3.2.3
          • Audacity 3.2.4
          • Audacity 3.2.5
        • Audacity 3.3
          • Audacity 3.3.1
          • Audacity 3.3.2
          • Audacity 3.3.3
        • Audacity 3.4
          • Audacity 3.4.1
          • Audacity 3.4.2
        • Audacity 3.5
          • Audacity 3.5.1
        • Audacity 3.6
          • Audacity 3.6.1
          • Audacity 3.6.2
          • Audacity 3.6.3
          • Audacity 3.6.4
    • Audacity Plugins
Powered by GitBook
LogoLogo

Get Audacity

  • Home
  • Download

Contribute

  • Tutorial makers
  • Translators
  • Testers
  • Developers

Audacity Help

  • Help & Tutorials
  • Manual
  • Help Forum

Resources

  • Plugins
  • Share your audio
  • Muse Hub

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

On this page
  • Heading 1
  • Heading 2
  • Inline text formatting options
  • Lists
  • Infoboxes, quotes and code blocks
  • Images and files
  • Embeds
  • Tables
  • Cards
  • Tabs
  • Expandable (Details block)
  • Drawings
  • LaTeX
  • Web API methods
  • API title
  • Dividers

Was this helpful?

Edit on GitHub
Export as PDF
  1. Community
  2. Contributing to Audacity
  3. Making Tutorials and User Guides

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∗e2piiξxf(x) = x * e^{2 pi i \xi x}f(x)=x∗e2piiξ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 column
text column, center-aligned
number 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

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

f(x)=x∗e2piiξxf(x) = x * e^{2 pi i \xi x}f(x)=x∗e2piiξ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

{
    // good Response
}
{
    // not found Response
}
{
    // 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.

PreviousEditing through GitHubNextTODO

Last updated 1 year ago

Was this helpful?

Inline image:

select-option column
files column
Ratings column
option a
option b
option coption boption a

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

YouTube embed
HomeAudacity ®
Arbitrary website without player
gist embed
soundcloud embed
2KB
transport toolbar.png
image
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

Logo