35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
[](https://creativecommons.org/licenses/by-nc-sa/4.0/)
|
|
|
|
# Home Assistant Data Science Portal
|
|
|
|
This is the source for the [Home Assistant Data Science Portal](https://data.home-assistant.io).
|
|
|
|
## Updating the docs
|
|
|
|
Documentation is build using [Docusaurus](https://docusaurus.io/docs/en/doc-markdown.html).
|
|
|
|
### Preparing environment
|
|
|
|
Running the documentation locally requires [NodeJS](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) to be installed. Inside a cloned fork of this repository, run:
|
|
|
|
```bash
|
|
$ script/setup
|
|
```
|
|
|
|
This will install [docusaurus](https://www.npmjs.com/package/docusaurus) amongst other things.
|
|
|
|
### Running docs locally
|
|
|
|
```bash
|
|
$ script/server
|
|
```
|
|
|
|
It will start a server at [localhost:3000](http://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.
|