BetterDiscord Docs

About

The docs website is built using VitePress, a modern static website generator purpose built for documentation. The documentation itself is stored in markdown format using as little Vue components as possible in order to maximize the plaintext readability both for local viewing in an IDE as well as those that want to read the docs through GitHub rather than the website.

Docs Structure

This is the current documentation structure for the markdown files. It covers a wide range of topics and each entry below has several subpages with detailed information.

.
├──User Guides             // Basic walkthroughs for the average end-user
├──Developer Guides        // General set of guides useful for all developers
|   ├──Plugins             // Walkthroughs and information for plugin developers
|   └──Themes              // Informational guide to create themes for BetterDiscord
└──API Reference           // Non-walkthrough API reference
    ├──BetterDiscord API   // Detailed reference of everything available on BdApi
    └──Discord             // Advanced info on Discord's internals (subject to change)

The markdown pages under BetterDiscord API (aside from the overview/index) are automatically generated via a pair of scripts to extract the JSDoc from BetterDiscord and process it into markdown.

Project Structure

.
├──.vitepress     // VitePress folder for config and customization
|  └──theme       // Extension of the default theme
├──docs           // All the markdown documentation
|   ├──public     // Static assets available at url root
|   └──<others>   // See the structure above
└──scripts        // Helper scripts to generate the api reference

Contributors

For information on contributing to this project, please see CONTRIBUTING.md.