Documentation

The documentation is built with VuePress v2. The pages are written in Markdown and are located in the docs directory.

Small changes

If you want to make small changes to the documentation, you can do so directly in the GitHub web interface. Just navigate to the file you want to change and click the pencil icon in the top right corner.

There is a link on the bottom of each page to edit the file directly in the GitHub web interface.

Local development

If you want to make larger changes to the documentation, you can clone the repository.

Developing with Visual Studio Code and Docker

1. Install Visual Studio Code.

2. Install the Remote - Containers extension.

3. Go to the Node-RED Home Assistant repository and fork it.

4. Clone your forked repository to your local machine.

   git clone https://github.com/<GITHUB_USER_NAME>/node-red-contrib-home-assistant-websocket
   

5. Open the repository in Visual Studio Code.

6. Click on the green "Open a Remote Window" button in the bottom left corner and select "Reopen in Container".

7. Open a terminal in Visual Studio Code and run pnpm docs:dev to start the development server.

Manual environment

1. Install Node.js.

2. Enable pnpm

   corepack enable && corepack enable npm
   

3. Go to the Node-RED Home Assistant repository and fork it.

4. Clone your forked repository to your local machine.

   git clone https://github.com/<GITHUB_USER_NAME>/node-red-contrib-home-assistant-websocket
   

5. Open the repository in your favorite editor.

6. Run pnpm install to install the dependencies.

7. Run pnpm run docs:dev to start the development server.