Installation

Clone the repository, install dependencies, and run the dev server in under a minute.

This guide walks through setting up a local copy of nxt-whitepapers — useful if you plan to contribute a paper, fork the project, or just want to read offline.

Prerequisites

You'll need:

Node.js 20 or later (the build uses Turbopack, which expects modern Node)
npm 10 or later (or pnpm/yarn, but examples use npm)
A terminal you're comfortable with

If you're on macOS and using Homebrew, brew install node@20 will get you both Node and npm in one shot.

Install

Clone the repository

Pull the source from GitHub. You can fork first if you plan to push changes back.

git clone https://github.com/your-org/nxt-whitepapers.git
cd nxt-whitepapers

git clone git@github.com:your-org/nxt-whitepapers.git
cd nxt-whitepapers

gh repo clone your-org/nxt-whitepapers
cd nxt-whitepapers

Install dependencies

npm install

This installs Next.js, Fumadocs, Tailwind, and a handful of MDX plugins. Expect 30–60 seconds on a cold cache.

Start the dev server

npm run dev

The site is now live at http://localhost:3000. Edits to .mdx files hot-reload — no restart needed.

Verify

Open the homepage and confirm the sidebar lists at least one section. If it's empty, the content pipeline hasn't picked up the MDX files — usually a stale .source/ cache.

rm -rf .source
npm run dev

Don't commit the .source/ directory. It's generated at build time from content/docs/ and is already in .gitignore.

Next steps

Once the dev server is running, head to Configuration to tailor the site name, theme, and search behavior. Or skip straight to Writing your first whitepaper if you're ready to publish.

How is this guide?