https://github.com/flarum/docs
Flarum documentation.
https://github.com/flarum/docs
hacktoberfest
Last synced: about 2 months ago
JSON representation
Flarum documentation.
- Host: GitHub
- URL: https://github.com/flarum/docs
- Owner: flarum
- License: mit
- Created: 2016-02-20T23:32:55.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T22:14:32.000Z (2 months ago)
- Last Synced: 2025-04-11T10:19:58.517Z (about 2 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage: https://docs.flarum.org
- Size: 14.7 MB
- Stars: 69
- Watchers: 14
- Forks: 130
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing-docs-translations.md
- License: LICENSE
- Code of conduct: docs/code-of-conduct.md
Awesome Lists containing this project
README
# Flarum Docs
This repository contains the source code for [Flarum's docs site](https://docs.flarum.org).
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](https://crowdin.com/project/flarum-docs). We really appreciate all contributions, and these measures help ensure that documentation is up to date and avoids breaking unexpectedly. See [our docs](https://docs.flarum.org/contributing-docs-translations) for more information.
## Testing locally
Our documentation is generated with [Docusaurus](https://docusaurus.io/docs).
Use Yarn to install the dependencies and start Docusaurus in a local webserver:
```bash
yarn install
yarn run start
```