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.
Search is powered by Algolia via Docusaurus's built-in Algolia theme. Algolia uses an external web crawler that periodically indexes the deployed site at https://docs.flarum.org — it does not index local builds.
This means:
- New or updated pages will not appear in search until they are deployed to production and the Algolia crawler has re-indexed the site.
- Pages must be listed in
sidebars.jsto be included in the built site and therefore indexed. - Search results are filtered by doc version (
contextualSearch: true), so2.xpages won't appear when searching from the1.xdocs and vice versa.
To manually trigger a re-index after a significant content addition, use the Algolia Crawler dashboard (requires Algolia account access for appId: QHP1YG60G0, indexName: flarum).
Our documentation is generated with Docusaurus. Use Yarn to install the dependencies and start Docusaurus in a local webserver:
yarn install
yarn run start