Next Docs

The powerful framework for building documentation sites in Next.js.

Next.jsDocumentationStatic site generator
fuma-nama/next-docsnext-docs-zeta.vercel.appnext-docs-zeta

README

next-docs


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 docuementation websites.

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

  1. ```bash
  2. npm install next-docs-zeta
  3. ```

Next Docs UI


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

  1. ```bash
  2. npm install next-docs-ui
  3. ```

Create Next Docs App


A CLI tool that generates documentation sites.

  1. ```bash
  2. npx create next-docs-app
  3. ```

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.