Stories

Detail Return Return

初夏上新!Docsify 迎來 v5.0.0-rc.1 重磅發佈 - Stories Detail

在中國傳統曆法中,五月初一象徵着初夏的啓程,也寓意着新的成長與蜕變。今天,我們很高興地宣佈 —— Docsify v5.0.0-rc.1 版本發佈!

在延續零構建、即寫即部署理念的同時,Docsify 迎來了全新的樣式設計、更友好的可訪問性以及更穩健的插件機制。

可以通過訪問 http://preview.docsifyjs.org/ 進行體驗。

那麼,這個版本有哪些值得關注的亮點?我們為你準備了一份簡潔明瞭的更新説明:

全新樣式系統:現代化 UI 與 CSS 重構

本次更新帶來了 Docsify 自 2017 年以來首次 全面的 UI 更新CSS 樣式系統重寫,包括:

  • 使用現代 CSS 語法與構建工具(如 CSS 自定義屬性、PostCSS)重構所有核心樣式
  • 提供一個全新的 “核心主題”,簡化樣式維護,提升一致性
  • 引入主題插件(Theme Add-ons)機制,支持靈活組合顏色、字體、排版等樣式
  • 加強無障礙訪問(Accessibility)、響應式表現與交互體驗
  • 保持大多數 v4 插件兼容性,遷移成本低

亮點功能包括:

  • 🧩 一個核心樣式文件,多個可組合的主題插件(如 Vue 風格、深色模式、漸變背景等)
  • 🎨 更豐富的 UI 元素樣式:按鈕、表單、提示框、任務列表、鍵盤快捷鍵等
  • 🔍 重構搜索插件樣式,新增鍵盤快捷鍵提示
  • 🧠 更合理的結構與 class 命名,方便擴展與定製
  • 🧪 全瀏覽器測試支持(Chrome、Firefox、Safari、Edge)

這一重構參考了社區項目 docsify-themeable,將 Docsify 核心樣式與主題樣式解耦,並內置了豐富的 CSS 自定義屬性,使主題定製更加靈活高效。

感謝 @jhildenbiddle 在 #2469 中的實現。

加強無障礙訪問與導航優化

為了讓更多用户無障礙地使用 Docsify,本次更新在可訪問性方面也做出了顯著優化。

我們新增了“跳至主內容”的快捷鏈接,方便使用鍵盤或屏幕閲讀器的用户快速定位正文區域;

同時,對導航欄和側邊欄的交互元素補充了 ARIA 屬性,使頁面結構對輔助技術更友好。

無論是視覺用户還是依賴輔助工具的用户,都能獲得更清晰、流暢的導航體驗。

靈活自定義的鍵盤快捷鍵配置

為了進一步提升文檔站點的可用性與交互體驗,Docsify v5 引入了鍵盤快捷鍵支持。通過新增的 keyBindings 配置項,用户現在可以通過鍵盤快速完成常見操作:

  • 按下 /Cmd/Ctrl + k 可快速聚焦搜索框,這一快捷鍵已成為 Docusaurus、GitBook、Starlight 等主流文檔工具的通用操作;
  • 按下 \ 可快速展開或收起側邊欄,方便在內容與導航之間切換。

重要 Bug 修復,提升穩定性與用户體驗

本次版本修復了一系列關鍵問題,確保 Docsify 在各類使用場景下表現更加穩定流暢:

  • 修復了純數字 ID 導致的問題(#2021)
  • 修復了嵌入內容處理循環的結束條件(#1824)
  • 改進了 isExternal 功能的增強(#2093)
  • 修復了無障礙角色和 ARIA 標籤問題(#2304)
  • 修復了搜索索引生成錯誤(#1933)
  • 修復了 Husky 升級後無法自動安裝問題(#2325)
  • 修復了 Carbon 代碼塊渲染異常(#2387)
  • 防止了不必要的 themeColor 棄用通知彈出(#2403)
  • 修復了開發模式下熱重載及 Source Maps 問題(#2402)
  • 修復了“跳轉至主內容”功能的滾動行為(#2401)
  • 修復了搜索索引生成錯誤(#1933)
  • 修復了別名含參數時擴展名追加錯誤(#1855)
  • 防止了不必要的 IntersectionObserver 初始回調執行(#2523)
  • 清理了搜索內容中的 Markdown 元素(#2457)
  • 修復了自動標題配置的生成函數錯誤(#2474)
  • 修復了 loadSider 設為 false 時的渲染結構問題(#2470)
  • 同步了頁面標題以匹配標題配置(#2478)
  • 修復了標題解析錯誤(#2526)
  • 修復了歷史路由模式下跨域鏈接問題(#1967)

移除 SSR(服務端渲染)支持

SSR 是實驗性的且不完整的,所以為了簡化代碼庫和提升維護效率,Docsify v5 移除了對服務端渲染(SSR)的支持。

希望有人有意願並且有時間時,可以提出一個全新且完整的 SSR/SSG 實現方案。

資源地址變更

v4 版本中的資源放在lib下並且同級有一個額外的 themes 目錄,而 v5 版本將其重命名為 dist,並移除了同級的 themes 目錄。

# v4
├── lib
│   ├── docsify.js
│   ├── docsify.min.js
│   ├── plugins
│   └── themes # 壓縮主題文件
└── themes # 原始主題文件

# v5
├── dist
│   ├── docsify.js
│   ├── docsify.min.js
│   ├── plugins
│   └── themes
  • v4:
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />


<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
  • v5:

需要注意的是:v5 的正式版本還未發佈,目前只能@rc標籤進行訪問,將下面的@5替換為@rc即可。

<!-- Core Theme -->
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/dist/themes/core.min.css" />
<!-- Vue Theme (add-on) -->
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/dist/themes/addons/vue.min.css" />

<script src="//cdn.jsdelivr.net/npm/docsify@5"></script>

強烈建議在引用 CDN URL 時使用 @ 指定版本,避免因為發佈新版本導致你的網站出現問題。

感謝所有貢獻者!

此次更新離不開社區每一位貢獻者的支持與努力,無論是功能開發、Bug 修復、文檔完善還是依賴升級,感謝你們推動 Docsify 向前發展!

特別感謝以下 首次貢獻者,歡迎加入 Docsify 社區!

  • @ablakey
  • @akshaybhinge19
  • @dzsibi
  • @ekoz
  • @eldemcan
  • @ezeamaka2
  • @JamesHenry
  • @julienw
  • @LBZZYZ
  • @luicfrr
  • @palmiak
  • @paulhibbitts
  • @thapasusheel
  • @timothyjohn2015
  • @wangliang181230

同時也感謝持續為項目做出貢獻的開發者:

  • @anikethsaha
  • @jhildenbiddle
  • @Koooooo-7
  • @sy-records
  • @trusktr

這一版本是 v5 正式版前的重要候選階段,我們期待社區開發者、用户和文檔愛好者的積極試用與反饋,共建更好的 Docsify!🎉

Add a new Comments

Some HTML is okay.