The framework for building documentation websites in Next.js.

📘 Learn More: Documentation

Installation

This monorepo includes three packages.

Next Docs Zeta

The headless UI library for building documentation websites.

It includes necessary parts such as TOC, Sidebar, and some useful utilities.

npm install next-docs-zeta

Next Docs UI

The framework is built on top of Next Docs Zeta. It offers many out-of-the-box features along with a well-designed user interface.

npm install next-docs-ui

Create Next Docs App

A CLI tool that generates documentation sites.

npx create next-docs-app

Compatiability

All packages are ESM only.

Contributions

We are welcome for contributions! You may start with contributing to the docs, it is located in /apps/docs/content/docs.

Notice that this project is a monorepo using Turborepo, pnpm and Changesets. Make sure to format your code with pnpm run prettier and add changeset with pnpm changeset.

Environment Variables

You don't need any extra environment variables to run this project locally.