开始使用
安装
开始使用 Docus。
create-docus CLI
创建您的文档目录
使用 create-docus CLI 来创建一个新的 Docus 项目:
Terminal
npx create-docus my-docs
您可以在两个模板之间选择:
default:用于单语言文档的基本 Docus 设置i18n:包含对多语言文档的国际化支持
Terminal
# Create with i18n template
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"],
});