繁体   English   中英

如何支持docusaurus维护的旧版本文档中的更改

[英]How to support changes in older versions of docs maintained by docusaurus

我正在尝试使用Docusaurus工具来创建文档站点。 到目前为止,一切正常,直到我来到Versioning为止。

我的理解是:

  1. /docs/**/*.md是您下一版本的最新文档
  2. 您的文档的先前版本可在/website/versioned-docs/version-${version-number}目录中找到

我不清楚我该如何维护/发布对先前版本的更改? 我在/docs/**目录中/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/zh-CN/versioning#fallback-functionality

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

Docusaurus的维护者在这里。 由于版本控制的实现方式,在V1中没有简单的方法来更新以前的版本。 您可能不希望更新以前的版本,因为发布时应冻结一个版本,而应对新版本进行更新。

但是,如果您坚持要求,则始终可以在versioned_docs/version-XXX目录下编辑生成的文件。 但是,我建议您对最新版本进行更改,并鼓励您的用户升级到最新版本。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM