Install

Install one of the documentation hubs from github.com/FarmBot-Docs:

  1. git clone https://github.com/FarmBot-Docs/farmbot-docs
  2. cd farmbot-docs
  3. Install ruby (check installation with ruby -v)
  4. gem install bundler
  5. bundle install

Serve

  1. bundle exec jekyll serve
  2. Open http://localhost:4000/ in a browser

Edit

Saving any changes will automatically trigger a rebuild.

Changes to _config.yml require re-running bundle exec jekyll serve.

Modifying the theme

The common documentation theme (assets/css, layouts, includes) can be modified in the farmbot-theme repository.

What’s next?