Krab logoKrab
入门

安装

开始使用 Docus。

create-docus CLI

创建文档目录

使用 create-docus CLI 创建新的 Docus 项目:

Terminal
npx create-docus my-docs

你可以在两个模板之间选择:

  • default:面向单语言文档的基础 Docus 配置
  • i18n:包含多语言文档所需的国际化支持
Terminal
# 使用 i18n 模板创建
npx create-docus my-docs -t i18n

我们推荐使用 npm 包管理器。

启动开发服务器

进入文档目录,并以开发模式启动文档服务器:

Terminal
cd my-docs
npm run dev

你的文档本地预览会在 http://localhost:3000 可用。

编写文档

前往编辑章节了解如何编写文档。

AI 助手技能

为你的 AI 助手(Cursor、Claude 等)添加专门知识,快速开始使用 Docus:

Terminal
npx skills add https://docus.dev

这个技能会为你的 AI 助手提供以下能力,帮助你更快创建文档:

  • 使用 Docus 编写文档的最佳实践
  • MDC 组件用法和可直接使用的模板
  • 写作指南和内容结构模式
  • 配置与自定义建议

安装后,你的 AI 助手可以帮助你搭建新的文档项目、生成结构正确的页面,并按照 Docus 最佳实践编写内容。

你也可以从自己的 Docus 站点发布技能。了解更多 Agent Skills。

Layer 集成

Docus 使用基于 Nuxt layer 的方式。你可以在 nuxt.config.ts 中通过 extends: ['docus'] 直接扩展 Docus layer:

nuxt.config.ts
export default defineNuxtConfig({
  extends: ['docus']
})
Copyright © 2026 Powered by Docus