home-assistant.io/README.md
2023-06-08 18:46:41 +02:00

43 lines
1.5 KiB
Markdown

[![Discord](https://img.shields.io/discord/330944238910963714.svg)](https://www.home-assistant.io/join-chat/)
[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
[![Deploys by netlify](https://www.netlify.com/img/global/badges/netlify-color-bg.svg)](https://www.netlify.com)
# Home Assistant website
This is the source for the [Home-Assistant.io website](https://home-assistant.io).
## Setup
Setting up to contribute to documentation and the process for submitting pull requests is explained in the [developer documentation](https://developers.home-assistant.io/docs/documenting/).
## Site preview
In order to make the preview available on `http://127.0.0.1:4000`, use the following [bundler](
https://bundler.io/
) command:
```bash
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`:
```bash
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.
```bash
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:
```bash
bundle exec rake integrate
```