100Errors / flarum.github.io

Flarum website.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Flarum documentation

Hi! Looking to contribute documentation to Flarum? That is great, we can use all the help. Flarum is evolving rapidly and so should its documentation.

This repo will eventually be deprecated in favour of flarum/docs. But until a definitive conversion date is planned, you are welcome to contribute here.

Get started

You can edit small changes online using the Github editor. For larger edits it is recommended to make a local checkout and test your changes before you commit them. To do that, you need Ruby. Instructions for Linux/Mac:

git clone https://github.com/flarum/flarum.github.io
cd flarum.github.io

cat > Gemfile <<EOM
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
EOM

bundle install
bundle exec jekyll serve

Now, you can view your changes through http://localhost:4000. Jekyll will automatically rebuild the site when you save your edits.

About

Flarum website.

License:MIT License


Languages

Language:HTML 61.1%Language:CSS 38.9%