<h1><picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/mastodon/mastodon/raw/main/lib/assets/wordmark.dark.png?raw=true">
  <source media="(prefers-color-scheme: light)" srcset="https://github.com/mastodon/mastodon/raw/main/lib/assets/wordmark.light.png?raw=true">
  <img alt="Mastodon" src="https://github.com/mastodon/mastodon/raw/mainlib/assets/wordmark.light.png?raw=true" height="34">
</picture></h1>

The documentation currently uses [Hugo](https://github.com/gohugoio/hugo) to generate a static site from Markdown. Use `hugo serve` to test the site locally. If build errors occur, ensure your Hugo version is the same as [docs.joinmastodon.org](https://github.com/mastodon/documentation/blob/main/.github/workflows/deploy.yml#L43).

View the live documentation at [https://docs.joinmastodon.org](https://docs.joinmastodon.org)

## Contributing to the Mastodon documentation

Please read the [Contributing to Mastodon](https://github.com/mastodon/.github/blob/main/CONTRIBUTING.md) guide. The same guidance applies to the documentation.

Also see the [Style](./DOCSTYLE.md) guide.

![help wanted](https://img.shields.io/badge/help_wanted-8A2BE2) there is a [list of currently undocumented topics](https://github.com/mastodon/documentation/issues/1211) that need some coverage, please feel free to take a look.
