devdocs
by Quincy Larson
昆西·拉尔森(Quincy Larson)
DevDocs加入了freeCodeCamp社区 (DevDocs is joining the freeCodeCamp community)
DevDocs is an open source web app that combines documentation for lots of developer tools into a single searchable interface.
DevDocs是一个开源Web应用程序，将许多开发人员工具的文档组合到一个可搜索的界面中。
I’ve been using DevDocs since before freeCodeCamp even existed, and have sung its praises over the years.
自从freeCodeCamp出现之前，我就一直在使用DevDocs，并且多年来赞扬它 。
The speed and simplicity of DevDocs is a real a breath of fresh air. Every API is laid out in the same clear hierarchy.
DevDocs的速度和简单性真是新鲜空气。 每个API都以相同的清晰层次结构进行布局。
So when it came time to design the freeCodeCamp Guide last summer, I already had a clear template in mind. We were going to create a DevDocs-like interface for exploring programming concepts.
因此，去年夏天设计freeCodeCamp指南时 ，我已经有了一个清晰的模板。 我们将创建一个类似于DevDocs的界面来探索编程概念。
I reached out to DevDocs creator Thibaut Courouble for advice. He was helpful in explaining how DevDocs worked and his reasoning behind some of his design decisions.
我向DevDocs的创建者Thibaut Courouble寻求帮助。 他对解释DevDocs的工作方式以及他的一些设计决策背后的推理很有帮助。
He and I kept in touch. We exchanged ideas for how to make tools that were more accessible to developers in parts of the world without reliable high-speed internet connections.
他和我保持联系。 我们交换了有关如何使工具在没有可靠的高速Internet连接的情况下对世界各地的开发人员更易于使用的想法。
Then a couple months ago, Thibaut approached me about the possibility of donating the DevDocs project to the freeCodeCamp community, so that we could continue to grow the project beyond what he is able to do as a lone maintainer.
然后，在几个月前，Thibaut向我询问了将DevDocs项目捐赠给freeCodeCamp社区的可能性，以便我们可以继续扩大该项目，使其超出他作为单独维护者的能力。
And today — exactly 5 years after Thibaut created DevDocs — I’m excited to announce that DevDocs is now officially part of the freeCodeCamp community!
今天，在Thibaut创建DevDocs仅仅5年之后，我很高兴地宣布， DevDocs现在正式成为freeCodeCamp社区的一部分 ！
DevDocs的简要历史 (A brief history of DevDocs)
Thibaut is a French developer who now works as a senior development lead at Shopify in Ottawa, Canada.
Thibaut是一位法国开发人员，现在担任加拿大渥太华Shopify的高级开发负责人。
Thibaut created DevDocs exactly 5 years ago today, on March 26, 2013. At the time, he just wanted a better way to quickly access the Mozilla Developer Network documentation.
Thibaut正是在5年前的今天(2013年3月26日)创建了DevDocs。当时，他只是想要一种更好的方法来快速访问Mozilla开发人员网络文档。
Originally, DevDocs was just an ordinary documentation folder on his hard drive, for his own personal use — the kind that many developers had on hand for reference. Then, after a few months of development, Thibaut launched DevDocs on June 18, 2013, as a free web app.
最初，DevDocs只是硬盘上的一个普通文档文件夹，仅供个人使用-许多开发人员都可以参考这种文件夹。 然后，经过几个月的开发，Thibaut作为免费的Web应用程序于2013年6月18日推出了DevDocs。
At first, Thibaut kept DevDocs closed source. But on October 24, 2013, he open-sourced it.
最初，Thibaut使DevDocs保持关闭源。 但是在2013年10月24日，他将其开源。
The DevDocs project has since gone on to accumulate more than 17,000 GitHub stars, along with 66 contributors (though Thibaut is still by far its most prolific contributor).
自那以后，DevDocs项目已经累积了超过17,000个GitHub明星，以及66位贡献者(尽管Thibaut仍然是迄今为止最多产的贡献者)。
Thibaut wrote dozens of scraping scripts to go out and automatically download documentation from different projects, each carefully-tuned to create a consistent reading experience and generate good search results.
蒂博(Thibaut)编写了数十个抓取脚本，用于外出并自动从不同项目中下载文档，每个脚本都经过精心调整以创建一致的阅读体验并生成良好的搜索结果。
Over the next two years, Thibaut added many improvements such as new documentation, keyboard shortcuts, better search, mobile support, and the ability to switch to a dark theme for night-time viewing.
在接下来的两年中，Thibaut进行了许多改进，例如新文档，键盘快捷键，更好的搜索，移动支持以及切换到黑暗主题进行夜间查看的功能。
Then, in 2015, Thibaut made DevDocs fully-functional offline. Suddenly, anyone could download entire sets of documentation for access offline. All of these files would be stored in the browser, thanks to a clever use of a new technology called IndexedDB.
然后，在2015年，Thibaut使DevDocs脱机了。 突然，任何人都可以下载整套文档以供离线访问。 由于巧妙地使用了称为IndexedDB的新技术，所有这些文件都将存储在浏览器中。
And in early 2016, Thibaut added support for versioning. Instead of being limited to only the most recent version of a documentation, DevDocs now started supporting multiple versions for each project and library.
在2016年初，Thibaut添加了对版本控制的支持。 现在，DevDocs不仅限于文档的最新版本，还开始为每个项目和库支持多个版本。
Those two major new features would turn out to be an inflection point in DevDocs’s user base. The project grew to become one of the most widely-used tools in the developer community.
这两个主要的新功能将成为DevDocs用户群的拐点。 该项目逐渐成为开发人员社区中使用最广泛的工具之一。
If you want to see how far DevDocs has come in the past five years, compare these two Hacker News threads:
如果您想了解DevDocs在过去五年中的发展情况，请比较以下两个Hacker News线程：
The first thread from June 2013 — mostly people unfavorably comparing DevDocs to other documentation projects (many of which are now defunct).
A second thread from late 2017 — in one of Hacker News’s most-upvoted threads of all time, people praise DevDocs — particularly for its speed. The message is clear: your project doesn’t have to be the first of its kind — you just have to stick with it and make consistent improvements to it, and you can emerge the leader.
2017年底的第二个线程 -在Hacker News历来最受赞誉的线程之一中，人们称赞DevDocs-特别是它的速度。 信息很明确：您的项目不必是同类中的第一个–您只需要坚持并对其进行持续的改进，就可以成为领导者。
Today, more than 100,000 developers use DevDocs as a reference each month.
如今，每月有超过100,000个开发人员使用DevDocs作为参考。
DevDocs的工作原理 (How DevDocs works under the hood)
One of the most common questions people ask Thibaut: how did DevDocs get to be so fast?
人们问Thibaut的最常见问题之一：DevDocs如何变得如此之快？
Thibaut attributes the speed of DevDocs to many factors:
Thibaut将DevDocs的速度归因于许多因素：
- DevDocs is a single-page Ruby web app with a tiny backend. DevDocs是具有小型后端的单页Ruby Web应用程序。
When you visit DevDocs.io, after the initial page load, all subsequent files (including documentation files) are fetched through a lightning-fast Content Delivery Network (CDN).
当您访问DevDocs.io时 ，在初始页面加载后，所有后续文件(包括文档文件)都通过快速的内容交付网络(CDN)来获取。
- It uses GZIP, HTTP caching, App Cache, concatenated and minified JavaScript and CSS 它使用GZIP，HTTP缓存，应用程序缓存，串联和缩小JavaScript和CSS
- There are no ads (ads slow everything down) 没有广告(广告会降低一切速度)
- It uses localStorage as an extra level of caching for some assets 它使用localStorage作为某些资产的额外缓存级别
- It uses an in memory cache for things like instant backward and forward navigation 它使用内存缓存来实现即时向后和向前导航
- It uses IndexedDB for caching entire sets of documentation locally on your computer 它使用IndexedDB在计算机上本地缓存整个文档集
- The documentation is stripped of all remote assets and unnecessary markup, resulting in smaller files 该文档去除了所有远程资产和不必要的标记，从而使文件更小
It uses optimized client-side search
它使用优化的客户端搜索
- It has a non-blocking and asynchronous user interface 它具有非阻塞和异步用户界面
It features an optimized DOM tree with a paginated sidebar list, so that it doesn’t have to render 1,000's of nodes right away
它具有经过优化的DOM树，并带有分页的侧边栏列表，因此不必立即渲染1,000个节点
- It has a simple user interface that eschews frills like shadows or animations 它具有一个简单的用户界面，可避免诸如阴影或动画之类的装饰
Finally, DevDocs doesn’t use any jQuery or any JavaScript frameworks. All of the DOM operations are implemented manually, making them as fast as they can get. (Thibaut says he wouldn’t recommend this no-framework approach for most apps, but it works well for DevDocs.)
最后，DevDocs不使用任何jQuery或任何JavaScript框架。 所有DOM操作都是手动实现的，因此可以使其尽快获得实现。 (Thibaut说，他不会为大多数应用程序推荐这种无框架的方法，但是对于DevDocs来说效果很好。)
如何参与 (How you can get involved)
Right now we’re looking for a passionate and experienced Ruby developer who is interested in becoming a long-term contributor to DevDocs.
目前，我们正在寻找一个热情且经验丰富的Ruby开发人员，他有兴趣成为DevDocs的长期贡献者。
We’re also looking for people interested in making DevDocs easier to contribute to, through writing documentation and refactoring code.
我们还正在寻找对通过编写文档和重构代码使DevDocs易于做出贡献感兴趣的人。
You can also help by reporting any bugs or feature requests you have in the issue tracker, and helping triage or fix those.
您还可以通过报告问题跟踪器中存在的任何错误或功能请求并进行分类或修复来提供帮助。
You can join the DevDocs contributor chatroom on Gitter and introduce yourself.
您可以在Gitter上加入DevDocs贡献者聊天室并进行自我介绍。
Lastly, you can help by using DevDocs and sharing it with your friends and colleagues. The next time you need to look up documentation, go to DevDocs.io.
最后，您可以通过使用DevDocs并与您的朋友和同事共享来提供帮助。 下次您需要查找文档时，请转到DevDocs.io 。
You can also search DevDocs with by typing “devdocs” into Chrome’s address bar and hitting tab. And DuckDuckGo has a special !dd command to search DevDocs as well.
您还可以通过在Chrome的地址栏中输入“ devdocs”并点击标签来搜索DevDocs。 DuckDuckGo还有一个特殊的!dd命令也可以搜索DevDocs。
Join me in welcoming Thibaut and DevDocs to the freeCodeCamp community by tweeting at him.
和我一起通过发推文欢迎Thibaut和DevDocs进入freeCodeCamp社区。
Have fun, and happy coding!
玩得开心，编码愉快！
翻译自: https://www.freecodecamp.org/news/devdocs-is-joining-the-freecodecamp-community-ae185a1c14a6/
devdocs
228
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
