From 916e0e9b0444658c468952f9b4174695ca63f2a0 Mon Sep 17 00:00:00 2001 From: Olanti Date: Wed, 20 Sep 2023 22:12:23 +0300 Subject: [PATCH] docs: add npm instructions to docs tutorial --- doc/src/content/docs/en/contribute/docs.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/src/content/docs/en/contribute/docs.md b/doc/src/content/docs/en/contribute/docs.md index f46406be8be0..7949da6bb030 100644 --- a/doc/src/content/docs/en/contribute/docs.md +++ b/doc/src/content/docs/en/contribute/docs.md @@ -102,7 +102,8 @@ as you go. To run the documentation site locally, you need to: -- install [node](https://nodejs.org/en) and [pnpm](https://pnpm.io) for dev server +- install [node](https://nodejs.org/en) for dev server +- (optional) [pnpm](https://pnpm.io) as faster and more space efficient alternative to node's stock npm - (optional) [deno](https://deno.com) to format and generate automated documentation ### Setup dev server @@ -114,10 +115,16 @@ To run the documentation site locally, you need to: ```sh (Cataclysm-BN) $ cd doc (Cataclysm-BN/doc) $ pnpm install # 'pnpm i' for short - (Cataclysm-BN/doc) $ pnpm dev ``` +Or, if you're not using pnpm: +```sh +(Cataclysm-BN) $ cd doc +(Cataclysm-BN/doc) $ npm install # 'npm i' for short +(Cataclysm-BN/doc) $ npm run dev +``` + You will be able to access the documentation site at `http://localhost:4321`. ## Live preview