安装

View source
学习如何快速安装 Movk Nuxt Docs,并通过项目模板或层集成方式开始您的文档项目。

快速入门

根据您的需求选择合适的模板:

完整文档站点(推荐)

适合构建完整的文档网站,包含 ESLint、TypeScript 检查等开发工具。

Terminal
# 使用完整模板创建新项目
npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
pnpm dev

模块文档站点(精简)

适合为 npm 包或库快速创建文档,内置 Release 页面展示版本发布历史,无额外开发工具。

Terminal
# 使用模块模板创建新项目
npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/module my-module-docs
cd my-module-docs
pnpm dev

项目启动后,您可以在 http://localhost:3000 访问本地预览。

作为 Layer 使用

在现有 Nuxt 项目中使用 Movk Nuxt Docs 作为 layer:

Terminal
# 安装依赖
pnpm add @movk/nuxt-docs better-sqlite3

在 CSS 中导入 Tailwind CSS 和 Nuxt UI

app/assets/css/main.css
@import 'tailwindcss';
@import '@nuxt/ui';

nuxt.config.ts 中配置:

nuxt.config.ts
export default defineNuxtConfig({
  extends: ['@movk/nuxt-docs'],
  css: ['~/assets/css/main.css'],
  llms: {
    domain: 'https://docs.mhaibaraai.cn',
    title: 'Movk Nuxt Docs',
    description: '一款优雅的 Nuxt 文档主题'
  }
})
Copyright © 2024 - 2026