Skip to content

Commit

Permalink
docs: Update documentation developement guide for pnpm
Browse files Browse the repository at this point in the history
  • Loading branch information
zachowj committed Aug 22, 2024
1 parent 1a272a8 commit 58f8d48
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/guide/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,17 @@ If you want to make larger changes to the documentation, you can clone the repos

1. Open the repository in Visual Studio Code.
1. Click on the green "Open a Remote Window" button in the bottom left corner and select "Reopen in Container".
1. Open a terminal in Visual Studio Code and run `npm install --save-dev` to install the dependencies.
1. Run `npm run docs:dev` to start the development server.
1. Open a terminal in Visual Studio Code and run `pnpm docs:dev` to start the development server.

### Manual environment

1. Install [Node.js](https://nodejs.org/).
1. Enable pnpm

```sh
corepack enable && corepack enable npm
```

1. Go to the [Node-RED Home Assistant](https://github.com/zachowj/node-red-contrib-home-assistant-websocket) repository and fork it.
1. Clone your forked repository to your local machine.

Expand All @@ -39,5 +44,5 @@ If you want to make larger changes to the documentation, you can clone the repos
```

1. Open the repository in your favorite editor.
1. Run `npm install --save-dev` to install the dependencies.
1. Run `npm run docs:dev` to start the development server.
1. Run `pnpm install` to install the dependencies.
1. Run `pnpm run docs:dev` to start the development server.

0 comments on commit 58f8d48

Please sign in to comment.