NextGuide

NextGuide documentation

Get started with NextGuide, choose a mode, and learn the essentials.

Welcome to NextGuide

Create a documentation site inside your existing Next.js app with one npm package. Choose how you want to work:

Developer ModeWrite MDX in files, use Git, and deploy to static hosting.Account ModeSet up and manage your site in a browser with a protected owner account.

Install in three steps

BunShell
bun add nextguide@alpha
bunx nextguide init --developer
bun run dev

For browser-based editing, use bunx nextguide init --account instead. Account Mode needs an App Router project and a persistent Node.js server.

Current package channel

NextGuide remains on the npm alpha channel. Features in the current source may not be available in every published alpha. Always check your installed version and the release notes.

What do you want to do?

Install NextGuideFirst-time setup and generated filesUse Account ModeOwner setup, sign-in, the editor, and deploymentAdd-on ecosystemMarketplace plan, manifests, and extension APIsWrite documentationPages, components, and MDXComponent libraryReusable UI, code blocks, and file treesDeploy a siteHosting options and persistence requirements

NextGuide contains MDX, UI components, OpenAPI, fonts and theming in the same package. No extra NextGuide packages are required.