From 9eb747d6861b5b586b944571790a0a5f9de9f197 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Tue, 9 May 2023 15:28:41 +0200 Subject: [PATCH] Add info on how to run the docs locally Closes GH-2297. Reviewed-by: Titus Wormer --- docs/community/contribute.server.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/community/contribute.server.mdx b/docs/community/contribute.server.mdx index d6e9db4ed..8ec367a46 100644 --- a/docs/community/contribute.server.mdx +++ b/docs/community/contribute.server.mdx @@ -34,6 +34,14 @@ As a user you’re perfect for helping us improve our docs. Typo corrections, error fixes, better explanations, new examples, etcetera. All MDX docs live in `docs/`. +You can run the docs locally by following those steps: + +* Use Node.js 14 +* Install latest npm (not the one coming with Node.js 14): `npm install -g npm` +* Install repository packages: `npm install` +* Build the docs site: `npm run docs-prod` +* Test the static docs site: `npx serve public` + ### Improve issues Some issues lack information, aren’t reproducible, or are just incorrect.