The Rocket.Chat server, desktop, mobile, user, admin & developer documentation.
Clone or download
LuluGO Snap docs for next release 0.73 (#1030)
* added doc for new snap features in release 0.73
Latest commit 162836f Jan 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis Add node-gyp to travis Mar 23, 2017
_data Added docs for channels.join endpoint (#1046) Jan 18, 2019
_includes [FIX] Broken links (#975) Nov 6, 2018
_layouts Add pricing links (#900) Sep 3, 2018
_sass Project icon related updates (#923) Nov 21, 2018
administrator-guides Comment out drive section Jan 17, 2019
bots Add bBot page to bot docs (#916) Sep 18, 2018
community-cookbook Update dependencies. (#969) Nov 22, 2018
contributing Added docs for channels.join endpoint (#1046) Jan 18, 2019
developer-guides Added docs for channels.join endpoint (#1046) Jan 18, 2019
getting-support German User Group (#974) Nov 8, 2018
images Fixes mismatching home bg (#905) Sep 11, 2018
installation Snap docs for next release 0.73 (#1030) Jan 18, 2019
public Fix some mobile view bugs (#904) Sep 5, 2018
user-guides Update README.md (#999) Nov 22, 2018
.gitignore added vendor/** Apr 30, 2018
.mdlrc Fix newliles Nov 17, 2017
.travis.yml Update dependencies. (#969) Nov 22, 2018
CODE_OF_CONDUCT.md Fix broken links/markdown on the docs (#533) Jan 31, 2018
CONTRIBUTING.md Improve the main readme page and remove some redundant files (#729) May 5, 2018
Gemfile Add tests and update travis.yml (#520) Jan 31, 2018
Gemfile.lock Update dependencies. (#969) Nov 22, 2018
LICENSE.md Create LICENSE.md (#865) Aug 2, 2018
README.md [NEW] GraphQL Documentation (#849) Dec 17, 2018
Rakefile Fix broken links/markdown on the docs (#533) Jan 31, 2018
_config.yml bump version Nov 21, 2018
favicon.ico Updated icon assets Jul 30, 2018
main.js Start moving the css of the website May 21, 2018
markdown-style.rb Update dependencies. (#969) Nov 22, 2018
styles.scss Add more improvements to css May 23, 2018

README.md

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.

How to run Rocket.Chat Docs locally:

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".