根据您的需求选择合适的模板:
适合构建完整的文档网站,包含 ESLint、TypeScript 检查等开发工具。
# 使用完整模板创建新项目
npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
cd my-docs
pnpm dev
适合为 npm 包或库快速创建文档,内置 Release 页面展示版本发布历史,无额外开发工具。
# 使用模块模板创建新项目
npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/module my-module-docs
cd my-module-docs
pnpm dev
项目启动后,您可以在 http://localhost:3000 访问本地预览。
在现有 Nuxt 项目中使用 Movk Nuxt Docs 作为 layer:
# 安装依赖
pnpm add @movk/nuxt-docs better-sqlite3
在 CSS 中导入 Tailwind CSS 和 Nuxt UI
@import 'tailwindcss';
@import '@nuxt/ui';
在 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 文档主题'
}
})