【Github开源】一站搞定各种开发文档

开发者的苦恼：经常要在多个API文档中切换，浏览器书签栏收藏各种语言相关的接口说明文档。

无意中在Github上发现DevDocs^[1]这个开源项目，它是一个把所有开发相关的文档以web的形式做了一个综合的网站，并提供搜索，离线访问，移动版本支持，暗黑主题，快捷键操作等功能。

访问：https://devdocs.io/

在访问前你需要知道的：

1.打开preference^[1]设置，勾选上你需要访问的文档列表，并且可以设置主题

image

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

获取更多作者文章，关注公众号太空编程