Installation
Requirements
- Node.js 22.22.3+ (22.x), 24.15.0+ (24.x), or 26+. The content database uses the built-in
node:sqlite, sobetter-sqlite3is not needed - Nuxt 4.6.1+ (4.x), Tailwind CSS 4 and
@nuxt/content3, all peer dependencies installed in your project
Create from a template
All three templates come with extends, a landing page and sample docs already set up:
| Template | Best for | Includes |
|---|---|---|
default | General documentation sites | Landing page, docs pages, ESLint and type checking |
i18n | Multilingual sites | default plus @nuxtjs/i18n, with Simplified Chinese and English content |
module | npm package or Nuxt module docs | default plus a releases.yml release notes page |
Replace default in the command with the template you need:
pnpm dlx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
pnpm dev
npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
npm run dev
yarn dlx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
yarn dev
bunx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
bun dev
nuxi init asks whether to install dependencies after creating the project. Then open http://localhost:3000.
The .env.example file in each template lists the available environment variables. Copy it to .env and fill in what you need:
# Reads GitHub commits and releases; required in production
NUXT_GITHUB_TOKEN=
# Enables AI Chat when set
AI_API_KEY=
# Optional: OpenAI-compatible endpoint; leave empty to use AI Gateway
AI_BASE_URL=
AI_API_KEY, otherwise the build fails with the install command to run.Add to an existing project
Install dependencies
pnpm add @movk/nuxt-docs @nuxt/content tailwindcss
npm install @movk/nuxt-docs @nuxt/content tailwindcss
yarn add @movk/nuxt-docs @nuxt/content tailwindcss
bun add @movk/nuxt-docs @nuxt/content tailwindcss
@nuxt/content must be a dependency of your application. The generated collection types only work when it resolves from the application scope; otherwise server-side queryCollection and friends are inferred as never.Extend the layer
export default defineNuxtConfig({
extends: ['@movk/nuxt-docs']
})
Write your first page
Docs must live in content/docs/, and the route prefix is always /docs:
---
title: Introduction
description: My first documentation page.
---
## Getting started
Write your content in Markdown.
Numeric prefixes in file names only control ordering, so the route above is /docs/getting-started. The landing page is rendered from content/index.md, or from app/pages/index.vue if you prefer a Vue page. See Project Structure for more conventions.
Optional dependencies
Features that are off by default need extra dependencies. If you enable one without them, the build fails and prints the install command:
| Feature | Dependencies |
|---|---|
| AI Chat | ai @ai-sdk/openai @ai-sdk/vue @comark/vue @shikijs/engine-javascript @shikijs/langs @shikijs/themes |
| Component docs | nuxt-component-meta vue-component-meta prettier |
| Mermaid | mermaid dompurify |
| Accessibility checks | @nuxt/a11y |
| Internationalization | @nuxtjs/i18n |
See Feature Flags for how to enable each one.
Let an AI assistant help
The Agent Skills published by this site can be installed into AI assistants such as Claude Code or Cursor, so they generate pages that follow the theme's conventions:
npx skills add https://docs.mhaibaraai.cn
Your own site publishes its skills/ directory the same way, see Agent Skills.
Introduction
Movk Nuxt Docs is a Nuxt Layer you can extend to get typography, navigation, search, SEO and AI features for a documentation site. This page explains what it suits, what is included by default and what you can turn on.
Project Structure
What each directory and file does in a Movk Nuxt Docs project, where content goes, how routes are generated, which files turn into the releases and showcase pages, and what the two config files control.