mirror of
https://github.com/hanzo-docs/docs.git
synced 2026-10-26 10:55:57 +00:00
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
|
|
|
|
The framework for building documentation websites in Next.js.
|
|
|
|
📘 Learn More: [Documentation](https://next-docs-zeta.vercel.app)
|
|
|
|
## 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.
|
|
|
|
```bash
|
|
npm install next-docs-zeta
|
|
```
|
|
|
|
### 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.
|
|
|
|
```bash
|
|
npm install next-docs-ui
|
|
```
|
|
|
|
### Create Next Docs App
|
|
|
|
A CLI tool that generates documentation sites.
|
|
|
|
```bash
|
|
npx create next-docs-app
|
|
```
|
|
|
|
## Example
|
|
|
|
[](https://githubbox.com/SonMooSans/next-docs-ui-template)
|
|
|
|
View the [Template](https://github.com/SonMooSans/next-docs-ui-template)
|
|
repository on Github.
|
|
|
|
### Sources
|
|
|
|
Next Docs has native support for [Contentlayer](https://www.contentlayer.dev).
|