Developers website for Home Assistant.
Go to file
andrewsayre 02aae520d3 Fix broken link 2019-03-26 20:01:02 -05:00
.github Enable move bot (#9) 2018-05-04 10:38:36 +02:00
docs Fix broken link 2019-03-26 20:01:02 -05:00
script Add shebang to script/server to avoid errors (#154) 2018-12-01 23:29:21 +01:00
website Version bump to 0.90.0 2019-03-20 11:56:25 -07:00
.gitignore Migrate to Docusaurus 2018-04-24 09:52:18 -04:00
.nvmrc Migrate to Docusaurus 2018-04-24 09:52:18 -04:00
LICENSE.md Add LICENSE 2018-05-04 10:26:40 +02:00
README.md Clarifies the order of steps for documentation changes (#136) 2018-10-30 11:49:16 +01:00
crowdin.yaml Add translations foundation 2018-04-24 15:16:04 -04:00

README.md

License: CC BY-NC-SA 4.0

Home Assistant Development Documentation

This is the source for the Home Assistant Development documentation.

Updating the docs

Documentation is build using Docusaurus.

Preparing environment

Running the documentation locally requires NodeJS and Yarn to be installed. Inside a cloned fork of this repository, run:

$ script/setup

This will install docusaurus amongst other things.

Running docs locally

$ script/server

It will start a server at localhost:3000. You will need to navigate to the next version of the docs to see your changes applied. To do so click on the version number in the header and select next -> Documentation.

Adding a page

  • Create new page in docs/
  • Add new doc to website/sidebars.json

You will need to restart the server when creating a new file or make changes to sidebars.json. If you're updating a document, you will only need to refresh your browser to get the latest changes.