开发者的苦恼:经常要在多个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开源】一站搞定各种开发文档相关推荐

  1. 生态伙伴 | xiaopiu入驻飞书,助你高效创作,从原型到文档一站搞定!

    本期生态伙伴「xiaopiu原型」作为首批入驻飞书的专业设计工具,与飞书深度集成.结合飞书,将产品设计环节无缝嵌入用户整体的工作信息流,让产品方案的交付和沟通更加自然和高效,为企业提供一站式产品原型设 ...

  2. vb.net usb通用协议api_充电头百花齐放不通用,热门全协议充电头盘点,充电问题一站搞定...

    充电头百花齐放却不通用,热门全协议充电头盘点,充电问题一站搞定 快充用来一时爽,协议不握手,5V1A慢慢享 近些年来,由于智能手机的快速发展,手机的耗电量变得越来越大.但是电池技术始终没有得到突破,想 ...

  3. 开源轻量级办公系统Sandbox介绍以及配套开发文档连载

    1.Sandbox介绍 Sandbox是一个基于django框架开发的轻量级办公平台,主要模块有:权限控制.资产(库存)管理.设备管理.客户信息管理和工单流程管理,其目的在于建立一套规范化.统一化和清 ...

  4. 基于 SSM 的网上购物系统(源码 + 开发文档 已开源)

    你能做到的,比想像的更多.  一.项目背景 这个项目是自己从四月份开始学习 Spring + SpringMVC + MyBatis 后的一次项目实践,恰好赶上学校的数据库暑期课程实践,跟老师申请后更 ...

  5. Zeal一个好用的开源离线开发文档浏览器

    Zeal的官网是https://zealdocs.org/,其自我介绍是Zeal is anoffline documentation browser for software developers. ...

  6. php 后端 轻量 框架,GitHub - 22cloud/mixphp: 轻量 PHP 框架,基于 Swoole 的常驻内存型 PHP 高性能框架 (开发文档完善)...

    高性能 • 轻量级 • 命令行 MixPHP 是什么 MixPHP 秉承 "普及 PHP 常驻内存型解决方案,促进 PHP 往更后端发展" 的理念而创造,采用 Swoole 扩展作 ...

  7. Android 界面滑动实现---Scroller类 从源码和开发文档中学习(让你的布局动起来)...

    在android学习中,动作交互是软件中重要的一部分,其中的Scroller就是提供了拖动效果的类,在网上,比如说一些Launcher实现滑屏都可以通过这个类去实现..   例子相关博文:Androi ...

  8. 开发文档怎么编写_PoC 编写指南

    什么是 PoC PoC(全称: Proof of Concept), 中文译作概念验证.在安全界,你可以理解成为漏洞验证程序.和一些应用程序相比,PoC 是一段不完整的程序,仅仅是为了证明提出者的观点 ...

  9. M5(项目)-01-尚硅谷谷粒商城项目分布式基础篇开发文档

    M5(项目)-01-尚硅谷谷粒商城项目分布式基础篇开发文档 分布式基础篇 一.环境搭建 各种开发软件的安装 虚拟机: docker,mysql,redis 主机: Maven, idea(后端),Vs ...

最新文章

  1. 1. 文件系统——磁盘分区、各目录功能、硬盘
  2. 自动驾驶软件工程课程之SLAM(1)
  3. 数据结构课上笔记11
  4. JSP自定义标签由浅到深讲解
  5. python怎么背景实现循环_在Python的一段程序中如何使用多次事件循环详解
  6. DBGridEh全部属性设置详解
  7. PAT 1013 数素数
  8. [!] No `Podfile' found in the project directory.
  9. 易语言超级列表框 网络图片_川足快报| 四川优必选为老将汪嵩庆生、遂宁市第三届高中男子足球超级联赛开赛...
  10. Canvas: trying to use a recycled bitmap android.graphics.Bitmap
  11. 设置SQL数据库用户权限
  12. 求子集PHP,JavaScript求非空子集数目的实现方法
  13. SAP MM批量删除采购申请、采购订单
  14. 上网课用哪种耳机好、长时间听网课耳机推荐
  15. Spring Beans 自动装配 使用XML配置列子(带源码)
  16. 21闭关修炼 解析分册
  17. 通俗意义计算机网络安全,计算机网络安全技术问题与策略
  18. Android中Manifest.xml配置文件
  19. 真正的成功,是一群人一起成事
  20. 「RPA商战风云」从这次农行总部招标说起

热门文章

  1. 1057 数零壹(PAT乙级 C++实现)
  2. PDH光端机的原理_PDH光端机的作用优点
  3. 【渝粤教育】广东开放大学 社会工作行政 形成性考核 (52)
  4. 浅谈GPRS的几种应用方案
  5. button onclick 多个同名_多个按钮的OnClickListener()android
  6. 现代交换技术学习笔记001
  7. python函数调用时所提供的参数可以是变量吗_Python函数一章,关于变量参数调用(何时使用*)记录,pytho,章节,可变,的,什么,时候...
  8. 转hdmi_苹果本轻松接大屏,毕亚兹雷电接口转HDMI/VGA转换器评测
  9. 【锁相环系列3】QPSK解调之Costas锁相环去小频偏(重点环路滤波器参数设置和迭代核心代码详解)
  10. linux下网站服务器,Linux下使用Apache搭建Web网站服务器(示例代码)