Installation

View source

Create a complete documentation site in one step with the official project templates, or integrate @movk/nuxt-docs as a Nuxt Layer into an existing Nuxt project. Supports npm, pnpm, yarn, and bun, with both a full template and a slim module-docs template to choose from.

Quick start

Choose the installation method that fits you:

Full documentation site (recommended)

A complete template that includes development tooling such as ESLint and TypeScript checking.

npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
npm install
npm run dev

pnpm dlx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
pnpm install
pnpm dev

yarn dlx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
yarn install
yarn dev

bunx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
bun install
bun dev

Module documentation site (slim)

A slim template, suited to npm package docs, with a built-in Releases page.

npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/module my-module-docs
cd my-module-docs
npm install
npm run dev

pnpm dlx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/module my-module-docs
cd my-module-docs
pnpm install
pnpm dev

yarn dlx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/module my-module-docs
cd my-module-docs
yarn install
yarn dev

bunx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/module my-module-docs
cd my-module-docs
bun install
bun dev

Once started, visit http://localhost:3000.

AI assistant Skill

Get up to speed with Movk Nuxt Docs quickly by adding domain expertise to your AI assistant (such as Claude Code, Cursor, and others):

Terminal

npx skills add https://docs.mhaibaraai.cn

This skill helps you create documentation faster by giving your AI assistant:

Best practices for writing documentation with Movk Nuxt Docs
Usage of built-in components and ready-made templates
Authoring guidelines and content structure patterns
Configuration and customization tips

You can also publish Skills from your own documentation site. Learn more about Agent Skills.

Using it as a Layer

Integrate it into an existing Nuxt project:

npm install @movk/nuxt-docs @nuxt/content better-sqlite3 tailwindcss

pnpm add @movk/nuxt-docs @nuxt/content better-sqlite3 tailwindcss

yarn add @movk/nuxt-docs @nuxt/content better-sqlite3 tailwindcss

bun add @movk/nuxt-docs @nuxt/content better-sqlite3 tailwindcss

@nuxt/content must be installed in the app's own dependencies. It is a peerDependency of @movk/nuxt-docs: only when it is installed in the app scope can the content collection type augmentation generated by Nuxt resolve to it. Otherwise, server-side calls such as queryCollection will end up with never type errors.

Configure Nuxt:

nuxt.config.ts

export default defineNuxtConfig({
+  extends: ['@movk/nuxt-docs']
})

Introduction

Movk Nuxt Docs is an elegant documentation theme built on Nuxt 4 and Nuxt UI, with MDC syntax, automated component documentation, and AI integrations. This page gives an overview of all the core features so you can quickly understand what Movk Nuxt Docs brings to your documentation site.

Project Structure

Take a closer look at the directory structure of a Movk Nuxt Docs project and the responsibilities of each file, including the content/ directory, public/ static assets, nuxt.config.ts module configuration, and app.config.ts runtime UI configuration, with typical configuration examples.