home-assistant.io README

The project's README from github.com/home-assistant/home-assistant.io. As one markdown file: README.md.

Discord License: CC BY-NC-SA 4.0

Deploys by netlify

Home Assistant website

This is the source for the Home-Assistant.io website.

Access

You can access the site at the following URLs, depending on the target branch:

Additionally, Netlify provides a preview deployment for every pull request, linked in the first PR comment.

Setup

Setting up to contribute to documentation and the process for submitting pull requests is explained in the contributor documentation.

Site preview

In order to make the preview available on http://127.0.0.1:4000, use the following bundler command:

bundle exec rake preview

If the preview is not running on your local machine, pass the IP of the target machine from where it should be served as a parameter, i.e. to access on http://192.168.0.123:4000:

bundle exec rake preview[192.168.0.123]

Speeding up site generation

Every release we post long changelogs to the website. This slows down generation of the website significantly! We include some tools to temporarily exclude the blog posts that you're not working on out of the way.

bundle exec rake isolate[filename-of-blogpost]

When you're done working on the site, run the following command to move the posts back again:

bundle exec rake integrate

Home Assistant - A project from the Open Home Foundation

home-assistant.io (home-assistant/home-assistant.io)

smart-home
Searching Database…

10K ·GitHub
Home-assistant.io
What is this?This is the source repository for the Home-Assistant.io website, which hosts the official user documentation for Home Assistant, the open-source home automation platform.
Is this the Home Assistant app itself or just the docs site?It is only the documentation website source, built with Jekyll. The actual Home Assistant software lives in a separate repository.
How do I preview my changes to the docs locally?After following the contributor setup, run the bundler preview command to serve the site locally; if previewing from another machine, pass that machine's IP as a parameter.
What do I need installed to build the site?You need Ruby and Bundler (Jekyll's dependency manager) to install the gems and run the local preview server, as outlined in the contributor documentation.
Why does the site build get slow sometimes?Generating the site slows down significantly after each release because of the long changelog blog posts; the repo includes tools to temporarily exclude posts you're not working on and restore them when done.
Where can I view the live site versus in-progress changes?The production site tracks the current branch, a beta version tracks the rc branch, a development version tracks the next branch, and every pull request also gets a Netlify preview deployment linked in its first comment.
What are similar projects?zigbee2mqtt, glasshouse, WLED, esphome, EchoMuse, techo5, ha_xiaomi_home, local_roborock_server
Which topics is it in?jekyll, smart-home, home-assistant, home-automation, ruby, iot, css, documentation, hacktoberfest, html, javascript, self-hosted
Creator
home-assistant
Size
1.2 GB
Stars
10K
Updated
CommitOct 18
Age
11y
Commits · 90 Days