Documentation Home Assistant


The website you are reading now is the home of Home Assistant: https://home-assistant.io. This is the place where we provide documentation and additional details about Home Assistant for end users and developers.

home-assistant.io is built using Jekyll and these available dependencies. The pages are written in markdown. To add a page, you don’t need to know about HTML.

You can use the “Edit this page on GitHub” link to edit pages without creating a fork. Keep in mind that you can’t upload images while working this way.

For larger changes, we suggest that you clone the website repository. This way, you can review your changes locally. The process for working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a pull request.

To test your changes locally, you need to install Ruby and its dependencies (gems):

  • Install Ruby if you don’t have it already. Ruby version 2.3.0 or higher is required.
  • Install bundler, a dependency manager for Ruby: $ gem install bundler
  • In your home-assistant.github.io root directory, run $ bundle to install the gems you need.

Short cut for Fedora: $ sudo dnf -y install gcc-c++ ruby ruby-devel rubygem-bundler rubygem-json && bundle

Then you can work on the documentation:

  • Fork home-assistant.io git repository.
  • Create/edit/update a page in the directory source/_components/ for your platform/component.
  • Test your changes to home-assistant.io locally: run rake preview and navigate to http://127.0.0.1:4000
  • Create a Pull Request (PR) against the next branch of home-assistant.github.io if your documentation is a new feature, platform, or component.
  • Create a Pull Request (PR) against the current branch of home-assistant.github.io if you fix stuff, create Cookbook entries, or expand existing documentation.

It could be necessary that you run rake generate prior to rake preview for the very first preview.

Site generated by rake is only available locally. If you are developing on a headless machine use port forwarding: ssh -L 4000:localhost:4000 [email protected]_of_headless_machine