Skip to content
Developers website for Home Assistant.
JavaScript CSS Shell
Branch: master
Clone or download

Latest commit

jmartens and frenck Update development instructions for frontend (#445)
* Revise frontend github repo location

The home-assistant-polymer repo seem to redirect to the home-assistant/frontend, so use that instead

* Consistent dummy path

Be consistent and use the same dummy path for the frontend throughout this instruction

* Update docs/frontend_development.md

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>

* ✏️ Tweak

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Latest commit 45a0360 Mar 22, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Enable move bot (#9) May 4, 2018
blog Update 2020-02-18-106-custom-card-changes.md Feb 26, 2020
docs Update development instructions for frontend (#445) Mar 22, 2020
script Fix permissions for scripts in script directory (#425) Mar 7, 2020
src Remove discourse scrollbar (#415) Feb 19, 2020
static Remove discourse scrollbar (#415) Feb 19, 2020
.gitignore Migrate to Docusaurus V2 🐱‍🐉 (#412) Feb 19, 2020
.nvmrc Migrate to Docusaurus V2 🐱‍🐉 (#412) Feb 19, 2020
LICENSE.md Add LICENSE May 4, 2018
README.md Clarifies the order of steps for documentation changes (#136) Oct 30, 2018
docusaurus.config.js Re-enable RSS/Atom feed for the blog (#431) Mar 9, 2020
netlify.toml Re enable search 🔎 (#417) Feb 20, 2020
package.json Bump react-dom from 16.13.0 to 16.13.1 (#443) Mar 20, 2020
sidebars.js Migrate to Docusaurus V2 🐱‍🐉 (#412) Feb 19, 2020
yarn.lock Bump react-dom from 16.13.0 to 16.13.1 (#443) Mar 20, 2020

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.

You can’t perform that action at this time.