Install NextGuide
Add NextGuide to an existing Next.js application, generate documentation, and start writing.
Installation
NextGuide is installed into your existing Next.js application. It creates the documentation routes, MDX files, navigation, and styling for you. You do not need a separate documentation repository, server, or component registry for Developer Mode.
Current release channel
alpha tag until a stable release is available. The published alpha may not include every feature documented in the development version of this site. Check nextguide --version and the release notes when upgrading.1. Start with Next.js
You can use an existing project, or create a new one:
bunx create-next-app@latest my-docs
cd my-docsDeveloper Mode supports the App Router and Pages Router, JavaScript and TypeScript, and projects with or without a src/ directory.
2. Install the package
Run the command from your Next.js project root:
bun add nextguide@alphaNextGuide is one npm package. The application provides its own Next.js and React dependencies; there is no separate installation for MDX, OpenAPI, or the UI components.
3. Generate your documentation site
Initialize Developer Mode:
bunx nextguide init --developerThe CLI examines your Next.js project and creates a ready-to-edit documentation site. By default, your pages live under /docs, leaving the existing homepage intact.
To see what would be generated before changing files:
bunx nextguide init --developer --dry-runFor an unattended setup, specify the location:
bunx nextguide init --developer --base-path /docs --yesThe --replace-home flag explicitly authorizes backing up an existing homepage; it does not silently delete the original file. Use --router app or --router pages if the project contains both router types.
4. Start the application
bun run devOpen /docs on the address printed by Next.js (or / if you selected the homepage). Your documentation source lives in content/docs/; the generated project files can be edited like normal application code.
bunx nextguide page add guides/installation --title "Installation"NextGuide creates the MDX file and updates the sidebar metadata for you.
Next steps
Already using NextGuide?
Do not rerun init on an existing documentation site. Update the package, then preview bunx nextguide upgrade --dry-run. Adopting updated generated layouts is an explicit --refresh-generated operation with backups. See upgrading safely.
What about Account Mode?
Account Mode is a separate, unreleased browser-based setup and editing workflow. It needs an App Router application with a persistent Node.js server. Learn about Account Mode and its security requirements.
For contributors who need to test unreleased source code instead of the published alpha, see the development instructions.