【问题标题】:How to support changes in older versions of docs maintained by docusaurus如何支持 docusaurus 维护的旧版本文档的更改
【发布时间】:2019-05-26 12:24:19
【问题描述】:

我正在试用 Docusaurus 工具来创建文档站点。到目前为止,一切都还好,直到我开始版本控制。

我的理解是:

  1. /docs/**/*.md 中的任何内容都是您下一个版本的最新文档
  2. 您的文档的早期版本可在 /website/versioned-docs/version-${version-number} 目录中找到

我不清楚的是如何维护/发布对以前版本的更改?我在/docs/** 目录中的更改尚未准备好发布。那么,维护旧版本文档更改的机制是什么?

此外,Docusaurus 的文档说明如下:

后备功能

仅 docs 目录和侧边栏中的文件 与最新版本不同的文件将被复制 每次指定新版本时。如果没有变化 版本,Docusaurus 将使用最新版本的文件 那个文件。

例如,最新版本 1.0.0 的原始 id 为 doc1 的文档存在,并且与文档具有相同的内容 docs 目录中的 id doc1。当新版本 2.0.0 是 创建后,不会将 doc1 的文件复制到 versioned_docs/version-2.0.0/。仍然会有一个页面 docs/2.0.0/doc1.html,但它将使用版本 1.0.0 中的文件。

https://docusaurus.io/docs/en/versioning#fallback-functionality

因此,假设我现在需要维护/更新以前版本的文档,但该文件没有重复,因为在创建新版本时,该特定文件没有任何更改。现在,流程是什么?我是否手动将必要的文件复制到/website/versioned-docs/version-${version-number} 目录中,然后进行更改?

【问题讨论】:

标签: javascript docusaurus


【解决方案1】:

Docusaurus 维护者在这里。由于版本控制的实现方式,在 V1 中更新以前的版本并不容易。您可能不想更新以前的版本,因为版本在发布时应该被冻结,并且应该对新版本进行更新。

但如果你坚持,你总是可以在versioned_docs/version-X.X.X 目录下编辑生成的文件。不过,我建议您更改最新版本并鼓励您的用户升级到最新版本。

【讨论】:

  • 感谢@yangshun 的回复。是的,我也意识到我们可以编辑versioned_docs/version-X.X.X 目录下的文件。但是,如果我需要在该版本下添加新文件怎么办? yaml 前端的原始 id 字段值是多少?我认为不应该冻结文档版本。也许第一次文档不清楚或需要提供当时不可用的其他文档。因此,虽然特定版本的源代码应该被冻结,但我认为相关文档总是可以更改的。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2014-02-11
  • 2014-06-15
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2013-10-29
  • 2020-12-19
相关资源
最近更新 更多