UnDocs logoUnDocs

Getting Started

Write your docs as Markdown, drop in a single config file, and get a fast, elegant, zero-config documentation site — dev server, production build, search, and llms.txt included.

#Overview

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

#Stack

Undocs is currently powered by Nitro, Vite, md4x, rangi, Unhead and Reka UI.

UnDocs was originally based on Nuxt, Nuxt UI, Nuxt Content (Comark), Vue Router, and other Nuxt ecosystem modules such as nuxt-llms and nuxt-icon which inspired the new generation of undocs.

#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