docsify:輕量級 Markdown 文件網站生成器,打造即時更新的文件平台

docsify 是一款以 JavaScript 為基礎的輕量級文件網站生成工具,專為開發者和技術團隊設計,讓你能夠快速將 Markdown 文件轉換為即時渲染的網站。與傳統的靜態網站生成器如 GitBook 或 Hexo 不同,Docsify 採用「即時渲染」的方式,無需預先編譯 HTML 文件,讓文件更新更加即時且靈活。

docsify 的核心特色

  • 即時渲染docsify 在瀏覽器端動態解析 Markdown 文件,無需事先生成靜態 HTML 檔案,讓內容更新更為即時。

  • 輕量且快速核心程式碼壓縮後僅約 21KB,載入速度快,適合部署在 GitHub Pages、Gitee Pages 或任何靜態伺服器上。

  • 高度自訂化支援自訂封面(_coverpage.md)、側邊欄(_sidebar.md)、導覽列(_navbar.md)等,方便打造符合品牌風格的文件網站。

  • 豐富的外掛支援提供全文搜索、Emoji 表情、主題切換等多種插件,提升使用者體驗。

  • 多語系支援可輕鬆建立多語系文件結構,適合國際化團隊使用。

  • 相容性佳支援 IE11 以上的瀏覽器,並可搭配服務端渲染(SSR)使用。

以下則是官方展示的一些使用該套件的網站:

  • styled-wind - A magical implementation of tailwind-like classnames into styled-components.
  • pyecharts - Documentation for pyecharts. A Python Echarts Plotting Library.
  • gallery-pyecharts - A Data Visualization Gallery Based on pyecharts.
  • Posthtml - Documentation for PostHTML, a tool to transform HTML/XML with JS plugins.
  • Explore Wanchain - Documentation for Wanchain, a blockchain with smart contracts, private transactions, and cross-chain features.
  • Laravel SweetAlert2 - Documentation for Laravel SweetAlert2, A beautiful, responsive, highly customizable and accessible (WAI-ARIA) replacement for JavaScript's popup boxes for Laravel.
  • Security List - A series of personal cyber security tools, resources and checklists.
  • Snipaste - Snip & Paste.

 

 

可以透過 npm 安裝

npm i docsify-cli -g

 

或是使用以下樣板開始

<!DOCTYPE html>
<html>
<head>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
</head>
<body>
  <div id="app"></div>
  <script>
    window.$docsify = {
      //...
    }
  </script>
  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
</body>
</html>

 

課程推薦

用 AI 生成網站? AI 高效網站設計實戰課:ChatGPT X HTML X SEO

用 AI 生成網站? AI 高效網站設計實戰課:ChatGPT X HTML X SEO

利用 AI 提升網站設計效率與 SEO 排名!了解如何透過 ChatGPT 等工具快速建立 HTML 架構,優化關鍵字與用戶體驗,讓網站更具競爭力。

輸入折扣碼 TC1533SL 還可以額外獲得 NT$500 優惠喔。

AI工作術全面學習實戰營:6 堂精選課程,學會最好用 AI 工具,翻轉你的人生

AI工作術全面學習實戰營:6 堂精選課程,學會最好用 AI 工具,翻轉你的人生

《PChome雜誌》攜手 5 位在 AI 領域的專業講師,打造上述 6 堂實用課程,教你學會時下最好用的 AI 工具,導入生成式 AI 來產製工作內容,改造並升級你的工作流程。

輸入折扣碼 ZERO2024 還可以額外獲得 NT$400 優惠喔。

HTML與SEO實戰應用—並以ChatGPT助力提升網站品質與流量

HTML與SEO實戰應用—並以ChatGPT助力提升網站品質與流量

本課程專為希望深入了解 HTML 並有效結合 SEO 策略的學員設計。我們將重點放在 HTML 的深度學習與應用上,同時穿插介紹如何透過搜索引擎優化提升網站能見度。透過即時互動式的直播教學,加上 ChatGPT 的輔助,您將學習到如何建立一個結構優良、美觀且符合 SEO 標準的網站。這不僅會提升網站的用戶體驗,還會大幅提高網站的搜索引擎排名,進而增加訪客流量和潛在客戶。
用AI強化職場競爭力 ChatGPT、Midjourney從入門到精通

用AI強化職場競爭力 ChatGPT、Midjourney從入門到精通

在快速變遷的職場中,提升競爭力成為關鍵。透過引領潮流的AI技術,ChatGPT和Midjourney將助您勇攀高峰。無論您是AI新手還是專家,這個課程將引導您從入門到精通,解密AI的奧秘,並學習如何運用於職場。
GitHub Copilot AI 程式碼編輯工具應用實務班

GitHub Copilot AI 程式碼編輯工具應用實務班

讓學員瞭解有效地使用該工具來加速開發流程、提高程式碼品質和生產力。課程重點放在以 JavaScript 程式語言為例,介紹 Copilot 的基本原理、使用方法和最佳實踐。

輸入折扣碼 TC1456JA 還可以額外獲得 NT$500 優惠喔。

ChatGPT X Clipchamp AI 生成影片、配音與字幕應用實戰班

ChatGPT X Clipchamp AI 生成影片、配音與字幕應用實戰班

掌握Clipchamp AI的操作技巧,靈活運用Clipchamp AI進行影片編輯和創作,實現創意表達和傳播目的。

輸入折扣碼 TC1451JAN 還可以額外獲得 NT$500 優惠喔。

如何串接多種數位工具資訊?Looker Studio 資料視覺化實戰班|GoogleAds x FB廣告 x GA流量數據

如何串接多種數位工具資訊?Looker Studio 資料視覺化實戰班|GoogleAds x FB廣告 x GA流量數據

Looker Studio除了可協助使用者監控網站流量、廣告成效、選擇匯入資源的管道之外,還可以將數據資料多平台整合、數據報表即時更新、數據範本可重複套用的效益,透過自動化系統,將數據全部匯入同一個報表平台,是企業不可或缺的重要工具。

輸入折扣碼 TC1270JIA 還可以額外獲得 NT$500 優惠喔。

和我們交流

加入我們的社群,裡面會有一些技術的內容、有趣的技術梗,以及職缺的分享,歡迎和我們一起討論。