Minimal Documentation theme and CLI for shared usage across Nuxt modules
npm install @larbish/docus
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
Documentation Theme and CLI to write beautiful docs with Markdown.
Ship fast, flexible, and SEO-optimized documentation with beautiful design out of the box. Docus brings together the best of the Nuxt ecosystem:
- Nuxt 3
- Nuxt Content
- Nuxt UI
- Nuxt Image
- Nuxt LLMs
- Nuxt SEO
- UnJS ecosystem
- Nuxt Studio
Local development
- Clone this repository
- Install the latest LTS version of Node.js
- Install dependencies using pnpm install
- Run prepare command using pnpm run dev:prepare
- Run dev documentation built on top of Docus using pnpm run dev
Published under the MIT license.
Docus v3 has been entirely rewritten from scratch and is inspired and copied from undocs made by @pi0 💚
[npm-version-src]: https://img.shields.io/npm/v/docus/latest.svg?style=flat&colorA=020420&colorB=EEEEEE
[npm-version-href]: https://npmjs.com/package/docus
[npm-downloads-src]: https://img.shields.io/npm/dm/docus.svg?style=flat&colorA=020420&colorB=EEEEEE
[npm-downloads-href]: https://npm.chart.dev/docus
[license-src]: https://img.shields.io/npm/l/docus.svg?style=flat&colorA=020420&colorB=EEEEEE
[license-href]: https://npmjs.com/package/docus
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com