UnDocs logoUnDocs

Getting Started


Undocs is currently intended for UnJS docs only and is not fully customizable yet.
Contributions are more than welcome but please consider that this project is not ready yet to be used.
Make sure to use Bun and WSL for Windows. We don't guarantee stability yet and it is expected that it doesn't work time to time.

Overview

UnJS Docs is a minimal Documentation Theme and CLI for shared usage across UnJS projects.

It is made with Nuxt, Nuxt Content, and Nuxt UI Pro with a zero config and elegant CLI wrapper.

Quick Start

Create docs/ project with starter template:

npx giget gh:unjs/undocs/template docs --install

Go to the docs dir cd docs/

Start development server:

npm run dev

Build for production:

npm run build