开始使用
迁移
如何将您的文档从现有的 Markdown 解决方案迁移到 Docus
从 Docus v3 迁移到 v4
Docus v4 引入了一种新的基于层的方法,利用官方 Nuxt CLI 而不是自定义的 Docus CLI。虽然您现有的内容和配置仍然兼容,但您需要更新命令和项目设置。
⚠️ 重大变更
主要的重大变更与 CLI 命令相关:
| v3 | v4 |
|---|---|
npx docus init my-docs | npx create-docus my-docs |
docus dev | nuxt dev --extends docus |
docus build | nuxt build --extends docus |
您现有的 Markdown 内容和 MDC 语法无需任何更改即可正常工作。迁移主要涉及更新您的开发和构建工作流程。
迁移到 Docus
已经在使用基于 Markdown 的解决方案编写文档?无论是 Docus v1、Nuxt UI 文档模板,还是其他静态站点方案,迁移到 Docus 都简单直接。
Docus 提供了一个简洁且易于维护的解决方案,仅需一个依赖项:Docus 库本身。您无需管理多个依赖项。由于所有功能都内置并统一维护,让您的文档始终保持最新状态比以往更加轻松。
要进行迁移,只需将您现有的 Markdown 文件移动到 Docus 起手模板的 content/ 目录中即可。
之后,您会面临两种情况:
- 如果您的当前文档已使用 Nuxt Content 和 MDC 语法,请确保您内容中使用的组件在 Nuxt UI 中存在。如果缺少某些组件,您可以轻松创建自己的自定义组件。
- 如果您使用的是标准 Markdown,您可以直接复制这些文件。然后,逐步利用 Nuxt UI 提供的内置组件来增强您的文档。
一旦您的内容被移至 content/ 文件夹,您就可以按照配置文档来自定义您的应用。
Docus 的设计宗旨是专注于内容创作,因此如果您已经在使用 Markdown,就能轻松切换到它。