Getting Started

Prerequisites

• Node.js 20 or later
• npm, pnpm, or yarn

Install

npm install

Develop

npm run dev

Open http://localhost:3000 . Edits to files in content/ reload automatically.

Build

npm run build
npm run start

Add a Page

1. Create a new .mdx file under content/ (e.g. content/docs/api.mdx).
2. Add it to the matching _meta.js to control the sidebar order and title.

export default {
  index: 'Introduction',
  'getting-started': 'Getting Started',
  api: 'API Reference',
  deployment: 'Deployment'
}

Components

Nextra ships with several built-in MDX components: