instructions to run the docs locally

mdx-js · May 4, 2023 · 298599f · 298599f
1 parent e77be3a
commit 298599f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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.