制作在線和離線幫助文檔(使用手冊),用什么工具比較好?
共 1373字,需瀏覽 3分鐘
·
2022-02-09 17:28
看到這個問題我一定要回答,近期對文檔制作工具進行了整理,在這分享給大家。

Docsify 是一個神奇的文檔站點生成器。它很好地完成了文檔生成的任務。重要的是,它可以動態(tài)地呈現(xiàn)你的文檔,這意味著你無需將 MD 解析為 HTML — 只需要將你的文件放在正確的位置即可!除此以外,Docsify 有大量插件和一些主題可供選擇。它也有很好的文檔記錄(就像文檔生成器一樣)。當我自己項目的文檔使用這個工具時,我可能會有些偏見。它唯一的問題是(至少對我來說)與 IE 10(正如其在主頁上所說)的兼容性不是很好(但是他們正在嘗試進行兼容),而且它對相關鏈接缺少必要的支持。

Docute v4 文檔 Docute 是一個類似于 Docsify 的工具,但它有一個可愛的名字。最新的版本(v4)相比上一個版本要少一些文檔,同時也進行了一定程度的簡化。生成的文檔看起來簡約而優(yōu)雅??梢允褂?CSS 變量 定制主題。
Docute 不像 Docsify 那樣擁有強大的插件系統(tǒng),但它有著自己的優(yōu)勢。它建立在 Vue.js 之上,這導致包的大小相比于 Docsify 要大些,但擴展性好了很多。比如,在你的 MD 文件中,你可以使用一些內置的 Vue 組件,甚至你自己的組件。

Slate 文檔 Slate 可能是在 GitHub 上記錄你的項目以及小星星數(shù)量的領頭羊(~25,000)。它的文檔清晰,語法可讀性好,且有 everything-on-one-page 的特點。還具有非??煽康?GH wiki 文檔。它允許深度主題化 ,但因為文檔提供的信息不多,所以你需要自己去源碼挖掘。
遺憾的是,它的可擴展性很差,但勝在功能豐富,對于那些需要 REST API 文檔的人來說,這似乎是一個不錯的選擇。請記住,Slate 生成的是靜態(tài) HTML 文件,而不是在運行中動態(tài)生成文件。

Docusaurus 是一個易于維護開源文檔生成網(wǎng)站的工具。它是由 Facebook 創(chuàng)建的,使用的是 — 沒錯,就是它 — React。它可以將 React 組件和庫輕松地轉換或集成為一個整體來創(chuàng)建自定義頁面。無需其他工具,它還可以建立額外的 blog 直接整合到你的文檔網(wǎng)站,甚至無需其他工具!它可以與 Algolia DocSearch 很好地集成,使你的文檔易于導航。就像 Slate 一樣,它會生成靜態(tài) HTML 文件。

VuePress 是一個 Vue 驅動的靜態(tài)站點生成器,由 Vue.js 的創(chuàng)始人開發(fā)。這也是生成 Vue.js 官方文檔的可靠工具。作為一個生成器,它有非常友好的文檔。它還具有一個強大的插件和主題系統(tǒng),當然也繼承了優(yōu)秀的 Vue.js。uePress 宣稱其對 SEO 友好,這是因為它生成并輸出的是 HTML 文件。

GitBook 是用于編寫 MD 文檔和文本的工具。它為你提供了一個在線編輯器和免費 .http://gitbook.io 域名體驗。毫無疑問,在線編輯器很棒,但是涉及到布局,它并沒有太多的可定制性。該編輯器還有它的遺留桌面版本。但除非你是在做一個開源的項目,否則你需要為此付費。
我的相關回答:
有哪些好用的文檔生成工具, 以及為什么好?