【Github开源】一站搞定各种开发文档
開發者的苦惱:經常要在多個API文檔中切換,瀏覽器書簽欄收藏各種語言相關的接口說明文檔。
無意中在Github上發現DevDocs[1]這個開源項目,它是一個把所有開發相關的文檔以web的形式做了一個綜合的網站,并提供搜索,離線訪問,移動版本支持,暗黑主題,快捷鍵操作等功能。
訪問:https://devdocs.io/
在訪問前你需要知道的:
1.打開preference[1]設置,勾選上你需要訪問的文檔列表,并且可以設置主題
2.你甚至可以拋棄鼠標,使用鍵盤按鍵操作,查看快捷鍵說明[2]3.支持模糊搜索,比如“bgcp”就能搜索到“background-clip”的內容4.搜索特定的文檔,輸入名字即可或者縮寫,回車進入搜索結果5.可以使用瀏覽器的地址欄進行搜索,因為它被大部分瀏覽器內嵌安裝了6.DevDocs在手機端支持離線訪問,也可以在谷歌瀏覽器上安裝
因為它是開源的,還可以在本地進行安裝,該開源程序由兩部分組成,Ruby負責元數據和文檔的生成,Javascript負責app網站的搭建。
DevDocs需要Ruby 2.6.x的環境,libcurl庫和由ExecJS支持的Javascript運行時,裝好之后,運行以下命令:
git?clone?https://github.com/freeCodeCamp/devdocs.git?&&?cd?devdocs gem?install?bundler bundle?install bundle?exec?thor?docs:download?--default bundle?exec?rackup最后在瀏覽器訪問?localhost:9292[4]?第一次訪問會比較慢,要編譯靜態代碼。
或者免去環境安裝的麻煩,直接使用Docker進行安裝,命令如下:
#?First,?build?the?image git?clone?https://github.com/freeCodeCamp/devdocs.git?&&?cd?devdocs docker?build?-t?thibaut/devdocs?.#?Finally,?start?a?DevDocs?container?(access?http://localhost:9292) docker?run?--name?devdocs?-d?-p?9292:9292?thibaut/devdocs如果你有很好的想法,又懂編程,可以向開源提交代碼。
另外下面是開發者根據開源代碼移植開發的一些項目,做成了很多IDE的插件,比如前端常用的VSCode插件devdocs for VS Code[5],Atom plugin[6],Sublime Text plugin[7]?等等。
References
[1]?DevDocs:?https://github.com/freeCodeCamp/devdocs
[2]?preference:?https://devdocs.io/settings
[3]?快捷鍵說明:?https://devdocs.io/help#shortcuts
[4]?localhost:9292:?http://localhost:9292/
[5]?devdocs for VS Code:?https://marketplace.visualstudio.com/items?itemName=deibit.devdocs
[6]?Atom plugin:?https://atom.io/packages/devdocs
[7]?Sublime Text plugin:?https://sublime.wbond.net/packages/DevDocs
總結
以上是生活随笔為你收集整理的【Github开源】一站搞定各种开发文档的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 【重学JS系列】slice用法大合集
- 下一篇: 【详细教程】教你如何使用Node + E