Skip to content

Commit

Permalink
Add info on how to run the docs locally
Browse files Browse the repository at this point in the history
Closes GH-2297.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>
  • Loading branch information
slorber committed May 9, 2023
1 parent e77be3a commit 9eb747d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/community/contribute.server.mdx
Expand Up @@ -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.
Expand Down

1 comment on commit 9eb747d

@vercel
Copy link

@vercel vercel bot commented on 9eb747d May 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.