Flarum Docs

This repository contains the source code for Flarum's docs site.

In order to avoid conflicts and corruption during translation synchronization, we only currently accept content contributions in English, and translations are only accepted through crowdin. We really appreciate all contributions, and these measures help ensure that documentation is up to date and avoids breaking unexpectedly. See our docs for more information.

Testing locally

Our documentation is generated with Docusaurus. Use Yarn to install the dependencies and start Docusaurus in a local webserver:

yarn install
yarn run start