Skip to content
Revolt Team Wiki

Home

Welcome to the Revolt Team Wiki, if you’re not a member of the team, you might be looking for the Revolt Community Wiki or the developer documentation.

Useful areas of the wiki for quick access.

Contributing to the Wiki

Contributing is very straightforward, you can either use your favourite code editor or Obsidian to edit this wiki.

Simply download it from GitHub:

Terminal window
git clone https://github.com/revoltchat/team wiki
#    open `wiki` in your favourite code editor
# OR open `wiki/vault` in Obsidian

You can preview your changes locally if you wish:

Terminal window
cd wiki
pnpm i
pnpm dev

However, by using Obsidian you get a live preview of what your page will look like.

When working on the wiki:

  • You should take advantage of Obsidian features such as page links, e.g. Team Conduct.
  • You can add new groups/folders to the sidebar by editing astro.config.mjs and finding the sidebars configuration settings.
  • You need to restart the development server whenever you update any Markdown files, this is due to a limitation in the Starlight Obsidian plugin.