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
  • Editing through Github.com
  • Editing through a local editor
  • Technical notes

Was this helpful?

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

Editing through GitHub

PreviousStyle GuideNextGitbook Markdown syntax

Last updated 2 years ago

Was this helpful?

Any page of both support.audacityteam.org and plugins.audacityteam.org can be edited either on Gitbook (see for instructions) or using Markdown syntax on GitHub.

Note: Various formatting options available in Gitbook cannot be previewed on GitHub and most local Markdown editors. Be aware of the differences between

  • (plugins/support.audacityteam.org)

  • and

  • .

The reverse isn't true however: All Github-flavored markdown is supported in Gitbook.

Editing through Github.com

A link for GitHub is shown either on the right-hand side or in an overflow menu of any page:

Once you are on GitHub, you will see a pencil in the top right of the file.

You now can make your changes to the page.

Best Practice: Frequently switch between the Code and Preview tabs in GitHub to get a general sense of what your edit will look like.

Also, if you haven't already, now is a great time to familiarize yourself with the Style Guide.

Once you are done, press Propose Changes

This brings you to a page where you can review your changes. If you are satisfied, click Create Pull Request.

Editing through a local editor

Caution: Avoid using office suites like Microsoft Word, LibreOffice or Google Docs to edit Markdown. They tend to use very different formatting options, which don't transfer to plain text. As a rule of thumb, if it doesn't save in .txt or .md, it's not the right app to use as a Markdown editor.

Note: You will need to use some form of Git to make a pull request, so just downloading the ZIP will not work.

Once it's cloned, you'll find the files of support.audacityteam.org in the main branch, and the files of plugins.audacityteam.org in the plugins branch. Any additional branches have been split off from the main branch to preserve documentation for previous versions of Audacity.

Technical notes

  • While you technically can work directly in your fork's main/plugins branch, it is highly recommended to make a new branch based on upstream/main or upstream/plugins instead for your changes. This way, you can always fast-forward merge the latest changes into your fork.

  • When updating your fork's side-branches to the latest state of main, rebase it if possible.

After you click "create pull request", it will show up on and await review by an Audacity team member.

You can edit Markdown in any text editor. More advanced editors like may show useful shortcuts and visualizations for easier and faster editing, but in principle, even the simplest text editors like Windows Notepad can be used to create them.

To get started, first clone the repository, either using git clone by clicking the code button on and opening it in GitHub Desktop

Further information on using git with VScode can be found in the .

Outside from the , there are some more technical things you need to be aware of:

The sidebar menu is handled through , not the file structure itself. If you want the page you created to show up in the sidebar, you will need to update this file accordingly. That said: Try to match the structure of SUMMARY.md with the folder structure.

https://github.com/audacity/audacity-support/pulls
VSCode
https://github.com/audacity/audacity-support.git
https://github.com/audacity/audacity-support
VSCode docs
syntax requirements
SUMMARY.md
Gitbook-hosted pages
Github-flavored markdown renderers
Raw Markdown
Writing Tutorials and User Guides
On a technical level, this will create a "fork" of the page, found on your Github profile, with a new branch called "patch-#" in which you are editing. As long as you are within this branch, you can do whatever you want with out stepping on anyone's toes.
On a technical level, this creates a commit in your "patch-#" branch. A branch can hold as many commits as you like, so if you want to do multiple changes, you can exit the flow after clicking "propose changes" and edit another file instead.
Clicking this button creates a form...
... in which you can give an overview of your changes to the team.
Example of switching branches in the GitHub Desktop client
Example of switching branches in VSCode