Home Assistant Companion Documentation
This is the source for the Home Assistant Companion 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/setupThis will install docusaurus amongst other things.
Running docs locally
$ script/serverIt 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.