📘 Home Assistant User documentation
 
 
 
 
 
Go to file
Joakim Sørensen f278c3d3d5
Add note about how to obtain the API key
2023-03-27 11:03:20 +02:00
.devcontainer Devcontainer improvements (#24356) 2022-10-05 12:37:32 +02:00
.github Bump actions/checkout from 3.4.0 to 3.5.0 (#26707) 2023-03-25 23:07:41 +01:00
.vscode Add autocomplete and clarify type parameters for text selector (#24715) 2022-11-15 20:44:40 +01:00
plugins Add Jekyll terminology tooltip plugin (#26542) 2023-03-11 12:58:07 +01:00
sass Add Jekyll terminology tooltip plugin (#26542) 2023-03-11 12:58:07 +01:00
source Add note about how to obtain the API key 2023-03-27 11:03:20 +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 to Node.js 16, the latest LTS (#20064) 2021-10-30 16:44:36 +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 Move integration platform redirects to Netlify redirects file (#10483) 2019-09-29 14:59:44 +02:00
.remarkrc.js No dollar signs in shell code (#10477) 2019-09-29 20:24:23 +02:00
.ruby-version Bump ruby to 2.7.2, bump bundler 2.2.28 (#19488) 2021-09-27 09:23:59 -07:00
.textlintrc.json Add some terms to lint file (#26512) 2023-03-09 17:54:06 +01:00
CLA.md ✏️ Tweak 2019-10-16 23:25:04 +02:00
CODEOWNERS 2023.3: Beta release notes 2023-02-22 21:17:32 +01:00
CODE_OF_CONDUCT.md Update Code of Conduct, following Contributor Covenant 2.0 (#13588) 2020-05-25 20:20:34 +02:00
Dockerfile Fix Dockerfile for devcontainer (#17447) 2021-04-13 23:04:40 +02:00
Gemfile Bump nokogiri from 1.14.1 to 1.14.2 (#26245) 2023-02-15 10:32:33 +01:00
Gemfile.lock Bump sass-embedded from 1.59.3 to 1.60.0 (#26709) 2023-03-26 11:52:18 +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 URL Update (#22998) 2022-06-07 12:22:14 +02:00
Rakefile Clean up Rakefile (#26612) 2023-03-15 08:51:35 -04:00
_config.yml 2023.3.6 (#26691) 2023-03-22 23:58:59 -04: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 Bump textlint from 13.3.0 to 13.3.1 (#26380) 2023-02-27 11:25:29 +01:00
package.json Bump textlint from 13.3.0 to 13.3.1 (#26380) 2023-02-27 11:25:29 +01: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