mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-19 15:26:29 +00:00
Add docs how to dev
This commit is contained in:
parent
1902984dc7
commit
2c726962e8
23
README.md
23
README.md
@ -3,3 +3,26 @@
|
||||
# Home Assistant Development Documentation
|
||||
|
||||
This is the source for the [Home Assistant Development documentation](https://developers.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 `script/setup`.
|
||||
|
||||
### Running docs locally
|
||||
|
||||
```bash
|
||||
script/server
|
||||
```
|
||||
|
||||
It will start a server at [localhost:3000](http://localhost:3000).
|
||||
|
||||
### 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.
|
||||
|
6
script/bootstrap
Executable file
6
script/bootstrap
Executable file
@ -0,0 +1,6 @@
|
||||
set -e
|
||||
|
||||
cd "$(dirname "$0")/.."
|
||||
|
||||
cd website
|
||||
yarn
|
6
script/server
Executable file
6
script/server
Executable file
@ -0,0 +1,6 @@
|
||||
set -e
|
||||
|
||||
cd "$(dirname "$0")/.."
|
||||
|
||||
cd website
|
||||
yarn start
|
@ -54,6 +54,8 @@
|
||||
"Sensor": "Sensor",
|
||||
"entity_switch": "Switch Entity",
|
||||
"Switch": "Switch",
|
||||
"entity_weather": "Weather Entity",
|
||||
"Weather": "Weather",
|
||||
"external_api_rest_python": "REST API - Python bindings",
|
||||
"external_api_rest": "RESTful API",
|
||||
"external_api_server_sent_events": "Server-sent events",
|
||||
|
Loading…
x
Reference in New Issue
Block a user