跳至主內容

Docusaurus 3.4

·4 分鐘閱讀
Sébastien Lorber
Sébastien Lorber
Docusaurus 維護者，React 本週編輯

我們很高興宣布Docusaurus 3.4。

升級應該是容易的。我們的 發佈流程 遵守 語意版本。次要版本不包含任何重大變更。

Docusaurus blog post social card

要點​

標籤檔案​

文件和部落格外掛程式都已經支援 tags front matter 屬性，讓您能夠群組相關內容。但是，在 front matter 中內嵌宣告的標籤並不總是理想的。

使用 #10137，您現在可以在 tags.yml 檔案中宣告預先定義的標籤清單

blog/tags.yml
tag1:
  label: 'Tag 1'
  description: 'Tag 1 description'
  permalink: /tag-1-permalink

tag2:
  label: 'Tag 2'
  description: 'Tag 2 description'
  permalink: /tag-2-permalink

可以在部落格或文件檔案的前面部分使用這些預定義標籤

blog/2024-05-31-my-blog-post.md
---
tags: [tag1, tag2]
---

# Title

Content
保持標籤使用的一致性

使用新的 onInlineTags: 'throw' 外掛選項來強制使用預定義標籤，並防止貢獻者建立新的不需要的標籤。

雜湊路由器 - 實驗性質​

隨著 9859 的推出，我們新增了一個新的實驗性質雜湊路由器設定檔選項，透過 file:// 協定在本地開啟網站時，有助於離線瀏覽。

docusaurus.config.js
export default {
  future: {
    experimental_router: 'hash',
  },
};
警告

不建議將此模式部署在透過網路伺服器部署的網站上。

當此模式開啟時，Docusaurus 會選擇退出靜態網站呈現，並打造一個用戶端單一網頁應用程式，其中所有路由都會加上 /#/ 前綴。只產生單一的 index.html 檔案。這個檔案可以點選之後在瀏覽器中本地開啟，使用瀏覽器的 file:// 協定即可。這讓 Docusaurus 網站可以當作 .zip 檔案來散佈，讓讀者可以在沒有電腦中安裝任何複雜程式（瀏覽器除外）的情況下，進行離線瀏覽。

Docusaurus hash router - local browsing using the file:// protocol

試著瀏覽我們自己使用雜湊路由器打造的 Docusaurus 網站

實驗性質

這個功能是實驗性質的。如果您試用了，請在此處向我們說明使用情況 here。

網站儲存 - 實驗性質​

Docusaurus 使用瀏覽器 localStorage API 來維持 UI 狀態。

但有時儲存空間會在多個使用相同網域的網站間「共用」，導致儲存鍵衝突。這種情況通常會有兩種

  • 在多個 https://127.0.0.1:3000 網站上作業時
  • 在同個網域中主機多個網站時：https://example.com/site1/ 和 https://example.com/site2/

因此，我們推出了新的實驗性 siteStorage 組態選項

export default {
  future: {
    experimental_storage: {
      type: 'localStorage',
      namespace: true,
    },
  },
};

在 namespace: true 設定時，我們會將雜湊字尾套用在所有儲存鍵上，使它們僅限於目前的網站（根據 config.url 和 config.baseUrl。例如，theme 儲存鍵會變成 theme-x6f。您也可以提供自己的自訂字尾 namespace: 'suffix'。我們也讓您使用 type: 'sessionStorage'，而非預設的 localStorage。

實驗性質

此功能為實驗性質。如果您嘗試使用，請讓我們瞭解它對您運作情形如何 在此。

其他變更​

其他值得注意的變更包括

  • #10151：新增土庫曼語 (tk) 主題翻譯
  • #10111：新增保加利亞語 (bg) 主題翻譯
  • #10168：修正許多延遲已久的 Markdown 連結解析 bug
  • #10178：/search 頁面會依照 contextualSearch: false 設定運作
  • #10118：修正文件在生成索引類別卡片說明時，複數形式使用錯誤的問題
  • #10130：修正中斷的錨點檢查器因後置斜線而報告的偽陽性

查看3.4.0 變更記錄條目中，完整變更清單。