簡體   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