Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info on how to run the docs locally #2297

Merged
merged 1 commit into from
May 9, 2023
Merged

Add info on how to run the docs locally #2297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/community/contribute.server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
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