Getting Started

安装

开始使用 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 提供。

开始编写文档

前往 Markdown 语法 章节,了解如何编写文档。

层集成

Docus v4 使用 Nuxt 层级方案。你可以在 nuxt.config.ts 中直接通过 extends: ['docus'] 扩展 Docus 层:

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