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

简介: 开发者的苦恼:经常要在多个API文档中切换,浏览器书签栏收藏各种语言相关的接口说明文档。无意中在Github上发现DevDocs[1]这个开源项目,它是一个把所有开发相关的文档以web的形式做了一个综合的网站,并提供搜索,离线访问,移动版本支持,暗黑主题,快捷键操作等功能。

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

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


访问:https://devdocs.io/


在访问前你需要知道的:


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

6Z$$6SF2_XRN2IP{6N_0NUP.png


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




目录
相关文章
|
1天前
|
存储 JavaScript 网络架构
【开源图床】使用Typora+PicGo+Github+CDN搭建个人博客图床
【开源图床】使用Typora+PicGo+Github+CDN搭建个人博客图床
55 3
|
1天前
|
人工智能 文字识别 异构计算
关于github开源ocr项目的疑问
小白尝试Python OCR学习,遇到报错。尝试Paddle OCR部署失败,Tesseract OCR在Colab误操作后恢复失败。EasyOCR在Colab和阿里天池Notebook成功,但GPU资源不足。其他平台部署不顺,决定使用WebUI或阿里云轻应用。求教OCR项目部署到本地及简单OCR项目推荐。
31 2
|
1天前
|
Web App开发 前端开发 数据库
推荐GitHub上开源的一款独立开发者出海技术栈和工具合集
推荐GitHub上开源的一款独立开发者出海技术栈和工具合集
|
1天前
|
机器学习/深度学习 人工智能 API
『GitHub项目圈选06』推荐5款本周 超火 的开源AI项目
『GitHub项目圈选06』推荐5款本周 超火 的开源AI项目
127 0
|
1天前
|
自然语言处理 并行计算 PyTorch
GitHub 开源神器 Bark模型,让文本转语音更简单!
GitHub 开源神器 Bark模型,让文本转语音更简单!
|
1天前
|
SQL 存储 数据挖掘
从GitHub火到头条!这套万人期待的 SQL 成神之路PDF,终于开源了!
近年来,随着互联网技术的发展,数据分析领域越来越受到人们的重视。能够有效地操作和分析数据,已经成为很多企业和个人成功的重要保证。SQL 是数据操作和查询的重要工具,掌握它不仅可以帮助我们更好地利用数据,也可以为我们打开新的职业之门。
|
1天前
|
消息中间件 安全 druid
GitHub昙花一现!《Spring Boot趣味实战课》神作开源几分钟被下架
今天给大家分享好书了:刘水镜老师的 《Spring Boot趣味实战课》,网上依旧是没有开源版本!小编会在文末附电子版免费下载方式。 刘水镜是谁? 十余年持续技术文章输出,CSDN博客专家。2020年《 Spring Boot趣味私房课》专栏上线,凭借风趣幽默、深入浅出的写作风格深受读者好评。 《Spring Boot趣味实战课》 内容丰富、趣味实战是本书的两大特色 涵盖 Spring MVC、MyBatis Plus、Spring DaJPA、Spring Security、Quartz等主流框架 整合MySQL. Druid、Redis、 RabbitMQ、Elastics
44 0
|
1天前
|
数据采集 人工智能 Rust
『GitHub项目圈选周刊01』一款构建AI数字人项目开源了!自动实现音视频同步!
『GitHub项目圈选周刊01』一款构建AI数字人项目开源了!自动实现音视频同步!
327 0
|
1天前
|
NoSQL Redis Docker
揭秘Github火爆的开源IP代理池秘密!
爬虫新利器:揭秘Github火爆的开源IP代理池秘密!
47 0
|
6月前
|
设计模式 Java 数据库
持续霸榜GitHub的面试神器:字节跳动Java面试参考手册,限时开源
最近又赶上跳槽的高峰期(招聘旺季),好多读者都问我有没有面试字节的神器,我苦苦寻到了一份内部资料《2023字节跳动Java面试参考手册(第二期)》。
http://www.vxiaotou.com