Fumadocs

版本管理

在您的文档中实现多版本支持。

概述

开发者工具相关的文档通常会对其进行版本化,例如为同一工具的 v1 和 v2 提供不同的文档。

Fumadocs 为您提供了实现自定义版本管理的基元。

部分版本化

当版本化仅适用于文档的部分内容时,您可以通过文件夹来分离它们。

例如:

getting-started.mdx
getting-started.mdx

注意

您可能希望使用侧边栏选项卡来对它们进行分组,而不是使用文件夹使用侧边栏选项卡

完整版本化

有时您希望对整个网站进行版本化,例如 https://v14.fumadocs.dev(Fumadocs v14)和 https://fumadocs.dev(最新的 Fumadocs)。

您可以为文档的某个版本创建一个 Git 分支(例如称为 v2),并将其部署为另一个子域名的独立应用,例如 v2.my-site.com

可选地,您可以从文档中链接到其他版本。 这种设计相对于部分版本化具有一些优势:

  • 易于维护:当您迭代或升级依赖项时,旧文档/分支不会受到影响。
  • 更好的连贯性:不仅仅是文档本身,您的登陆页面(以及其他页面)也将被版本化。

How is this guide?

Last updated on