Skip to content

Commit 9eb747d

Browse files
authoredMay 9, 2023
Add info on how to run the docs locally
Closes GH-2297. Reviewed-by: Titus Wormer <tituswormer@gmail.com>
1 parent e77be3a commit 9eb747d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed
 

‎docs/community/contribute.server.mdx

+8
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ As a user you’re perfect for helping us improve our docs.
3434
Typo corrections, error fixes, better explanations, new examples, etcetera.
3535
All MDX docs live in `docs/`.
3636

37+
You can run the docs locally by following those steps:
38+
39+
* Use Node.js 14
40+
* Install latest npm (not the one coming with Node.js 14): `npm install -g npm`
41+
* Install repository packages: `npm install`
42+
* Build the docs site: `npm run docs-prod`
43+
* Test the static docs site: `npx serve public`
44+
3745
### Improve issues
3846

3947
Some issues lack information, aren’t reproducible, or are just incorrect.

1 commit comments

Comments
 (1)

vercel[bot] commented on May 9, 2023

@vercel[bot]

Successfully deployed to the following URLs:

mdx – ./

mdx-git-main-mdx.vercel.app
v2.mdxjs.com
mdx-mdx.vercel.app
mdxjs.com

Please sign in to comment.