Deploy to Vercel

NextGuide Developer Mode is part of your Next.js application. You can deploy it using your normal Vercel workflow, without a separate NextGuide backend.

Before deploying

1. Build the application locally with bun run build and check for MDX, TypeScript, and routing errors.
2. Commit the files created by nextguide init --developer, including content/docs/, nextguide.config.json, the documentation route, and styles.
3. Import your application repository into Vercel and select the Next.js framework.
4. Deploy, then check the published documentation URL and internal links.

Next.js handles the build, prerendering, and assets. There are no special NextGuide credentials in Developer Mode.

Domains and preview deployments

Configure custom domains, HTTPS, preview deployments, and environment variables in your Vercel project settings. The documentation is served from the same application as your other pages.

Account Mode

The unreleased Account Mode preview writes documentation and private account state to persistent storage. Do not assume that a standard ephemeral serverless filesystem can hold that data. Account Mode needs additional hosting and security validation before production release.

Installation · Self-hosting