NextGuide

GitHub Pages

Publish a static NextGuide Developer Mode documentation site.

Deploy to GitHub Pages

Developer Mode can produce a static Next.js export, suitable for GitHub Pages and other file-only hosts. Account Mode cannot use GitHub Pages because it needs a running server and private persistent storage.

Configure Next.js

If your site is served at a repository path such as https://username.github.io/project/, configure the matching Next.js base path:

// next.config.mjs
const nextConfig = {
  output: "export",
  basePath: "/project",
  trailingSlash: true,
  images: { unoptimized: true },
}

export default nextConfig

Replace /project with your repository name. For a site on its own root domain, you generally do not need the basePath setting.

Build your site

bun run build

Next.js writes the static output to out/. Upload those files through a GitHub Pages deployment workflow or another publishing method supported by your repository. The build must complete successfully before you deploy.

If you use GitHub Actions for deployment, select GitHub Actions in repository Settings → Pages. This is a hosting choice for your own repository; NextGuide does not require any Actions workflow at runtime.

After deployment, check the site homepage, nested documentation pages, images, component examples, and internal links. A repository basePath must be reflected in your generated documentation URLs as well as your Next.js configuration.

Installation · Self-hosting