/discord-api-docs

Official Discord API Documentation

Primary LanguageMarkdownOtherNOASSERTION

Discord Official API Documentation

This repo contains the official Discord API documentation, which can be viewed online HERE. Before submitting pull-requests, please remember to fully read the Contributing guidelines.

This repository reflects the Discord API as it is meant to be accessed by third-party applications. It omits features and capabilities that are not generally available, or are not fully supported for third-party usage.

We welcome your contributions!

  • Issue tracker: Discord API bugs
  • Discussions: Discord API feature and improvement requests
  • Pull Requests: See Contributing.md

Markdown Syntax

This repository uses special markdown syntax that helps style the resulting web version of the documentation.

H6 Headings

H6 headings should be used above tables and code blocks to properly label them.

Linking

Links between docs can be achieved by using a hash symbol (#), plus the markdown file name, plus a slash, and finally the dash-separated anchor. For instance, to link to the above H6 heading section:

[Links to README.md H6](#README/h6-headings)

Alert Boxes

Alert boxes are achieved by using a block quote that has one of 'warn', 'danger' or 'info' on the first line.

Need some help?

Here are some Discord servers that can help you out with everything Discord API:

The Official Discord Developers server has plenty of help channels with knowledgeable people and Discord's developers to get you help with something you need, and get updates straight from the developers. However do keep in mind this is a purely on-topic server. If you are looking for a community, join the server below.

The Unofficial Discord API server is a common hangout for library and bot developers alike. It's a great starting point for those looking to dive in and learn bot-creation with the Discord API.

License

Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see LICENSE), and code samples in this repository are licensed under the MIT License (see LICENSE-CODE). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the Discord Developer Terms of Service for more information about use of Discord’s brand features and APIs.