Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nodejs/nodejs.org/llms.txt

Use this file to discover all available pages before exploring further.

This guide gets you from zero to a running local development environment in under five minutes.

Prerequisites

Before you begin, make sure you have:
  • Node.js v24.11.0 or later (check with node --version)
  • pnpm 10.28.2 (check with pnpm --version)
  • Git
  • A GitHub account
Use nvm or fnm to manage Node.js versions. The repository includes an .nvmrc file that pins the required version.

Steps

1

Fork and clone the repository

Fork the repository on GitHub, then clone your fork locally:
git clone git@github.com:<YOUR_GITHUB_USERNAME>/nodejs.org.git
Then add the upstream remote:
cd nodejs.org
git remote add upstream git@github.com:nodejs/nodejs.org.git
2

Install dependencies

Install all workspace dependencies using pnpm:
pnpm install --frozen-lockfile
This installs dependencies for all packages in the monorepo workspace (apps/site, packages/ui-components, packages/i18n, etc.).
3

Start the development server

pnpm dev
The site will be available at http://localhost:3000.The development server supports hot module replacement — changes to React components and MDX content are reflected immediately without a full page reload.
4

Make a change and verify

Try editing a content file to confirm everything is working:
# Open any MDX page in your editor
code apps/site/pages/en/index.mdx
Save the file and watch the browser update automatically.

Available commands

CommandDescription
pnpm devStart development server at http://localhost:3000
pnpm buildProduction build (Vercel deployment target)
pnpm deployStatic export build (legacy server target)
pnpm startStart the server with built content
pnpm lintRun ESLint across the workspace
pnpm lint:fixAuto-fix lint errors
pnpm prettierCheck formatting
pnpm prettier:fixFix formatting
pnpm formatRun all linters and formatters
pnpm testRun unit tests
pnpm storybookStart Storybook at http://localhost:6006

Next steps

Setup guide

Detailed environment setup including editor configuration.

Make your first contribution

Step-by-step guide to your first pull request.

Architecture overview

Understand how the website is built and structured.

Component system

Learn how to build and use React components.