Getting Started
迁移
如何将现有 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/ 文件夹后,就可以按照 configuration documentation 自定义你的应用。
Docus 的设计宗旨是让你专注于内容创作,因此如果你已经在使用 Markdown,就可以轻松切换。