home-assistant.io

This repository contains the source files for the Home Assistant user documentation website at home-assistant.io. Home Assistant is a widely used open-source smart home automation platform that lets people control and automate connected devices. This repo is not the platform itself; it is strictly the website and documentation.

The site is built with Jekyll, a tool that converts text and template files into a static HTML website. It is deployed automatically through Netlify. Three environments exist: production (the main live site), a beta version tracking release candidates, and a development version showing upcoming changes. Netlify also creates a preview build for each pull request, linked in the first PR comment, so contributors can inspect their changes before they are merged.

The README is brief and focused on contributors rather than end users. It explains how to run a local copy of the site for editing, using a Ruby tool called Bundler. Because every Home Assistant release ships a detailed changelog and those posts can slow down site generation significantly, there is a helper command to temporarily move blog posts out of the build while you work on something else, and another to put them back.

Contributions to the documentation go through standard GitHub pull requests. The developer documentation for Home Assistant explains the conventions and formatting rules contributors are expected to follow. The website content is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0. The project is part of the Open Home Foundation.