📘 Home Assistant User documentation

documentation hacktoberfest hass hassio home-assistant jekyll

Go to file

Erik Montnemery 97e533f4b6 Update binary sensor group documentation		2022-03-02 09:26:25 +01:00
.devcontainer	Update workflow and devcontainer to Node 14 (#19508 )	2021-09-28 10:13:53 +02:00
.github	Bump actions/setup-node from 2.5.1 to 3.0.0 (#21794 )	2022-02-25 08:27:07 +01:00
.vscode	Add configuration section to octoprint (#20323 )	2022-01-10 13:15:44 +01:00
plugins	Group integrations better (#20840 )	2021-12-23 18:42:28 +01:00
sass	Accessibility and SEO improvements (#21549 )	2022-02-19 20:33:20 +01:00
source	Update binary sensor group documentation	2022-03-02 09:26:25 +01: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 Overkiz documentation for new integration (#20841 )	2021-12-24 10:30:40 -10:00
CLA.md	✏️ Tweak	2019-10-16 23:25:04 +02:00
CODEOWNERS	Remove deprecated Bosch BMP280 Environmental Sensor integration (#21819 )	2022-02-27 12:21:36 -08: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.13.1 to 1.13.3 (#21734 )	2022-02-22 08:53:49 +01:00
Gemfile.lock	Bump jekyll-sass-converter from 2.1.0 to 2.2.0 (#21853 )	2022-03-01 14:05:00 +01: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 note about listen IP to README (#16307 )	2021-01-25 17:26:39 +01:00
Rakefile	Fix forum top Blueprint URLs (#19979 )	2021-10-26 09:21:08 +02:00
_config.yml	2022.2.9	2022-02-18 20:54:00 +00: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 remark-lint-no-shell-dollars from 3.1.0 to 3.1.1 (#20588 )	2021-12-06 08:37:13 +01:00
package.json	Bump remark-lint-no-shell-dollars from 3.1.0 to 3.1.1 (#20588 )	2021-12-06 08:37:13 +01:00

README.md

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