給 Web 開發人員推薦的文檔生成工具
工欲善其事必先利其器,在此給給 Web 開發人員推薦幾款優秀的開源文檔生成工具,希望能對大家有所幫助。
1、JavaScript
JSDoc 3
https://www.oschina.net/p/jsdoc
這是一款根據 Javascript 文件中注釋信息,生成 JavaScript 應用、庫、模塊的 API 文檔的工具。你可以使用它記錄如:命名空間、類、方法、方法參數等。該項目還衍生出了許多模板和其他工具來幫助生成和自定義文檔,比如:
模板
jaguarjs-jsdoc:https://github.com/davidshimjs/jaguarjs-jsdoc
DocStrap:https://github.com/docstrap/docstrap
jsdoc3Template:https://github.com/DBCDK/jsdoc3Template
minami:https://github.com/Nijikokun/minami
docdash:https://github.com/clenemt/docdash
tui-jsdoc-template:https://github.com/nhnent/tui.jsdoc-template
構建工具
JSDoc Grunt plugin:https://github.com/krampstudio/grunt-jsdoc
JSDoc Gulp plugin:https://github.com/mlucool/gulp-jsdoc3
其它工具
jsdoc-to-markdown:https://github.com/jsdoc2md/jsdoc-to-markdown
Integrating GitBook with JSDoc:https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3
ESDoc
https://esdoc.org/
一個 JavaScript 文檔生成器,按照規範編寫代碼注釋,即可生成友好的 JavaScript 代碼文檔。它可以將測試代碼和用戶手冊一併集成到文檔中,支持通過插件添加自定義功能。
Demo
2、API
apiDoc
http://apidocjs.com/
這是一款 RESTful Web API 文檔生成工具,一個在注釋裡邊編寫 API 文檔的小工具。有了它,只需在寫源碼的時候順手寫上一些簡單的注釋,就可以生成出漂亮的文檔了。項目支持大部分主流語言,注釋維護起來也比較方便,不需要額外再維護一份文檔。
Demo
GraphQL Voyager
https://apis.guru/graphql-voyager/
這是一款將任意 GraphQL API 表示為互動式圖形的工具,可以直觀地瀏覽 GraphQL API 。在設計或討論數據模型時,非常有用。
GIF/1850K
3、CSS / Style Guide
Knyle Style Sheets(KSS)
http://warpspire.com/kss
KSS 既是一份文檔規格說明,也是一種編寫樣式指南的格式,旨在幫助開發者自動化地創建可讀、可解析的樣式指南。它為團隊編寫具有可維護性、可文檔化的 CSS 提供一套方法。
React Styleguidist
https://react-styleguidist.js.org/
顧名思義,這是一款 React 樣式指南生成器,可與你的團隊分享在線樣式指南。它列出組件支持類型,並展示基於 Markdown 文件的實時、可編輯的使用示例。
Demo
GIF/361K
※這些優秀的主流代碼編輯器,你用過多少款?
※雲棲大會壓軸好戲,開源、安全、人工智慧一手掌握
※Docker 開源項目推薦
※勒索病毒甚囂塵上,雲棲大會帶你全面了解雲上安全
※網易開源軟體推薦
TAG:開源中國 |