📘 Home Assistant User documentation
 
 
 
 
 
Go to file
Franck Nijhof c51b56e26e
2025.4.3 (#38632)
2025-04-19 12:23:58 +02:00
.devcontainer Remove Ruby LSP from devcontainer (#33396) 2024-06-24 18:34:30 +02:00
.github build(deps): bump actions/setup-node from 4.3.0 to 4.4.0 (#38525) 2025-04-14 08:44:38 +02:00
.vscode Add more context to the Traccar Server documentation (#31207) 2024-02-04 15:21:46 +01:00
plugins Fix sort order and filter placement (#37904) 2025-03-10 15:52:01 +01:00
sass Fix target for alert spacing (#38570) 2025-04-16 12:40:51 +01:00
source 2025.4.3 (#38632) 2025-04-19 12:23:58 +02:00
.editorconfig Add EditorConfig file for Ruby files 2012-02-26 11:08:16 -08:00
.gitattributes Added .gitattributes file to keep CRLF's out of the codebase. 2013-03-06 01:29:40 +01:00
.gitignore Move the alert location (#18646) 2021-07-28 19:02:59 +02:00
.markdownlint.json Adds MarkdownLint configuration (#9725) 2019-06-29 14:35:45 +02:00
.nvmrc Update nodejs to 18x (#26746) 2023-03-27 20:10:27 +02:00
.powrc Adding .powrc to allow RVM to work when POW is updated to version 0.4.0 and beyond. 2012-06-08 13:58:52 -05:00
.remarkignore Enforce Markdown headers are incremental (#28158) 2023-07-10 17:02:21 +02:00
.remarkrc.js Enforce Markdown ordered list numbering (#28179) 2023-07-11 21:28:37 +02:00
.ruby-version Upgrade Ruby, Node, Jekyll, sass-embedded + devcontainer (#30538) 2023-12-28 14:40:03 +01:00
.textlintrc.json Revert "Remove JuiceNet integration" (#31785) 2024-03-07 18:13:10 +01:00
CLA.md ✏️ Tweak 2019-10-16 23:25:04 +02:00
CODEOWNERS Remove Sunweg integration (#38292) 2025-04-02 08:20:04 +00:00
CODE_OF_CONDUCT.md Enforce Markdown unordered list style (#28172) 2023-07-11 14:44:41 +02:00
Gemfile build(deps-dev): bump ruby-lsp from 0.23.13 to 0.23.14 (#38472) 2025-04-10 16:34:07 +02:00
Gemfile.lock build(deps-dev): bump sorbet-runtime from 0.5.12020 to 0.5.12024 (#38619) 2025-04-19 10:50:59 +02:00
LICENSE.md Adds GitHub Action for Remark, fixes code flag on fences (#10475) 2019-09-29 00:50:28 +02:00
README.md Add OHF logo to README (#34980) 2024-09-30 17:09:32 +02:00
Rakefile Clean up outdated/old school examples (#33284) 2024-06-15 12:32:39 -04:00
_config.yml 2025.4.3 (#38632) 2025-04-19 12:23:58 +02:00
config.rb Fix http generated images path when using Compass sprites 2013-07-13 23:22:29 +12:00
config.ru More fixes 2015-10-27 00:53:57 -07:00
package-lock.json build(deps-dev): bump remark-lint-fenced-code-flag from 4.1.1 to 4.2.0 (#38470) 2025-04-10 16:33:15 +02:00
package.json build(deps-dev): bump remark-lint-fenced-code-flag from 4.1.1 to 4.2.0 (#38470) 2025-04-10 16:33:15 +02:00

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.

Setup

Setting up to contribute to documentation and the process for submitting pull requests is explained in the developer 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