Skip to content

docs: improve local development instructions #133

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

Open
ojedaJD wants to merge 4 commits into
base: main
Choose a base branch
from
+18 −10
Open

docs: improve local development instructions #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e5ac3df
docs: improve local development instructions
ojedaJD Aug 28, 2026
c3eb4e8
fix: support localhost development origin
ojedaJD Aug 28, 2026
9bcb324
Merge branch 'main' into jo/improve-development-docs
ojedaJD Aug 29, 2026
b0e2610
docs: address development guide feedback
ojedaJD Aug 31, 2026
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
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,23 @@ for prior user-research context on content organisation.

## Building locally

This repository requires the Node.js version specified in the
[`.nvmrc` file](.nvmrc). Install the dependencies and generate the static site:

```bash
npm install
npm run build
# Output is written to out/
```

The output is written to `out/`. Start a local server from a separate terminal:

```bash
npx serve out
```

Open <http://localhost:3000/learn> to preview the site. Run `npm run build`
again after making changes to update the generated output.

## Code of Conduct

This project follows the
Expand Down
7 changes: 0 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,6 @@ The structure is based on
[Card Sort research](https://github.com/nodejs/nodejs.org/issues/8234)
conducted at the 2025 Cambridge Node.js Collaborators' Summit.

## Development

```bash
npm install
npm run build # generates static site + Orama search DB in out/
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).
8 changes: 6 additions & 2 deletions doc-kit.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,18 @@ import web from '@node-core/doc-kit/src/generators/web/index.mjs';
import { join } from 'node:path';

const origin =
process.env.VERCEL_ENV === 'preview' ? process.env.VERCEL_URL : 'nodejs.org';
process.env.VERCEL_ENV === 'preview'
? `https://${process.env.VERCEL_URL}`
: process.env.VERCEL_ENV === 'production'
? 'https://nodejs.org'
: 'http://localhost:3000';

@ovflowd ovflowd Aug 30, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Port 3000 can be taken... The thing is that this is defined at build-time... So nothing that can really be done, although it'd be cool if this port could be overridden. Although I doubt that many people will run this locally in a way that this could be a problem.


/** @type {import('@node-core/doc-kit/src/utils/configuration/types.d.ts').Configuration} */
export default {
global: {
output: 'out/learn',
input: ['pages/**/*.md'],
baseURL: `https://${origin}/learn`,
baseURL: `${origin}/learn`,
},
'jsx-ast': {
generateIndexPage: false,
Expand Down