Guides for developing and modifying Rocket.Chat's code--- layout: home permalink: /index.html

Rocket.Chat Docs

This is the official repository for Rocket.Chat Documentation.

This is a quick guide on how to run the docs site locally, for a more in depth guide please look here

install ruby (version 2.5 or higher recommended, if using any version prior to 2.5 you will need to install bundler with gem install bundler).
This step is for only macOS users:
- You will need to have either xcode or the xcode command line tools installed. To install the command tools use xcode-select --install. Don't forget to accept the sudo xcodebuild -license command.
- Depending on your setup you might need to install nokogiri and its dependencies manually.
Fork the repository.
Clone your fork.
Run bundle install inside of the cloned docs folder.
Start the server with bundle exec "jekyll serve --incremental --safe".