看Devdocs.io

DevDocs.io：程序员的文档神器，告别繁琐搜索！

核心要点：

• DevDocs.io是一个网络应用，提供快速访问众多前端语言和库的参考手册。其界面高效快捷，并具备实时模糊搜索功能。
• 平台仅整合官方内容，忽略用户提交的评论和示例。它是开源的，并通过GitHub鼓励社区贡献。用户甚至可以将其部署到本地以适应特定需求，例如公司的内部系统API。
• DevDocs.io针对移动设备进行了全面优化，并提供多种保持更新的方法。它可以作为Sublime Text和Brackets的插件，以及Firefox和Google Chrome的搜索引擎安装。它还提供各种直观的键盘快捷键，以提供流畅的用户体验。

你是否经常经历以下编码过程？

1. 需要[插入编程语言]函数定义和示例。
2. 谷歌搜索该函数。
3. 点击第一个结果，如果运气不好，就是w3schools，否则就是你正在使用的语言的在线手册。
4. 意识到你需要另一个函数的演示和解释。
5. 返回谷歌搜索，而不是使用语言网站上的搜索，因为它莫名其妙地糟糕且比重新加载标签页后的新谷歌搜索还要慢。
6. 重复以上步骤。

作为一名大量使用Web技术的开发者，我经常遇到这种情况。仅仅查找函数或语句的技术定义已经变得比以往任何时候都困难得多——不是在复杂性方面，而是在浪费的时间方面。如果我们能在一个地方拥有所有开发文档，在一个漂亮、支持离线访问的界面中，并具有超快的模糊搜索功能，用于任何语言，那不是很棒吗？DevDocs.io应运而生。

DevDocs.io是什么？

DevDocs是一个网络应用，旨在让您快速访问几乎所有前端语言和库的参考手册。它列出了给定所选语言的所有API及其官方文档，采用易于浏览和查看的格式，无需官方网站（如php.net）试图实现的那些不必要的菜单和俗气的样式。

这是一个使用Ajax驱动的开源网络应用，具有语法高亮显示功能，甚至可以作为Chrome扩展程序或Sublime Text或Brackets的插件使用。

DevDocs.io能做什么？

它聚合了所有流行语言的参考手册（前提是它们的手册具有易于访问和机器可读的格式）。它为您提供了一个流畅快捷的界面，用于模糊搜索所有所选语言的文档，以便尽可能用最少的按键找到所需信息。您可能想知道什么是模糊搜索？模糊搜索是搜索与您输入的内容大致（并非完全）匹配的字符串。Sublime Text和LightTable等编辑器在其命令搜索窗口中使用这种方法——输入类似“sa”的内容将为您提供“Save As..”，因为输入与命令的缩写匹配。输入“delte”将提供包含“delta”和“delete”的结果，输入“bgcp”甚至会提供“background clip”。这种类型的搜索允许对结果进行超快的微调，并且由于它们是实时的，因此您可以即时混合和匹配。

内容

DevDocs下载您选择的语言的参考手册索引，将其吸收到您的本地缓存中，然后从中提供结果。这意味着您必须在每台新机器上重新下载您选择的语言，但是这种操作方式带来的速度提升远优于使用远程请求的旧式Ajax方法。请注意——目前，只有索引是离线的，您点击的实际结果是从远程位置提供的——例如，即使在离线状态下它也会显示在搜索结果中，您仍然需要互联网访问才能获取JavaScript数组的文档。

重要的是要注意，获取的内容仅限于官方内容。这意味着用户提交的条目（如评论和示例）将被忽略。

您可以通过在搜索查询前添加“php”并按Tab或空格键（在移动设备上）来在特定语言范围内（例如，仅限PHP）搜索DevDocs。这会将搜索模式切换为“仅限所选语言”。要退出此模式，只需退格即可。

开源和本地部署

DevDocs是开源的，并鼓励社区以多种方式贡献。首先，它位于GitHub上，并邀请用户提交问题和改进代码，就像任何优秀的开源项目一样。其次，DevDocs可以轻松地部署到本地，因此您可以运行或托管您自己的版本。例如，将其适应公司内部系统的API非常容易。最后但并非最不重要的一点是，DevDocs使用Trello收集用户对所需语言的反馈。Trello是一个非常高效的基于团队的任务列表，支持各种信息看板，人们可以在其中协作、讨论和投票（主题）。DevDocs使用这些卡片来收集对各个语言集成的投票。要参与，请查看此处。

DevDocs定期维护和更新，并提供各种方法来了解最新的更改：

• 如果你在更新日期之后将其打开，网站本身会弹出一个包含最新更改的弹出窗口。
• 有一个新闻通讯。
• 有一个Twitter帐户。
• 甚至还有一个邮件列表。
• 有一个最新的变更日志。

所有这些似乎都来自同一个来源，因此最好只订阅其中一个。

其他优点

DevDocs针对移动设备进行了全面优化，并且具有高度响应能力。它打开速度很快，在移动设备上的工作方式与在桌面设备上完全相同。它的构建方式是网站的理想构建方式——在每台设备上都能获得流畅、快速且一致的体验。Thibaut Courouble确实做得非常出色。

如前所述，该应用程序可以作为Sublime Text和Brackets的插件安装——这意味着您可以直接从编辑器中搜索所需的API。更多插件即将推出，最值得注意的是JetBrains产品插件。该应用程序还正在移植到一个独立的零配置可下载离线版本。

DevDocs可以作为Firefox和Google Chrome的搜索引擎安装，以及基本上任何其他支持OpenSearch的浏览器和应用程序。OpenSearch是一组标准，允许某个资源将自身标识为搜索引擎。

还提供各种键盘快捷键，所有这些快捷键都非常直观且非常有用，提供了真正流畅的体验。

结论

如果您在阅读本文之前没有听说过DevDocs，我强烈建议您尝试一下。网络迫切需要这种高度易用的资源，因此请广而告之，帮助社区找到更好的解决方案来解决他们面临的问题。如果您能够贡献，DevDocs位于GitTip上并支持PayPal捐赠——但可以说，最好的帮助方式是使用它，告诉其他人关于它，最重要的是，通过在GitHub上为该项目做出贡献来改进它。

(以下为FAQ部分，已根据原文进行改写和精简，并保持原意)

DevDocs.io常见问题解答

• DevDocs.io与其他文档平台有何不同？ DevDocs.io以其简洁、快速和用户友好的界面而脱颖而出。它在一个快速、有序且可搜索的界面中整合了多个API文档。与其他平台不同，DevDocs.io允许用户下载文档以供离线使用，即使没有互联网连接也能访问。它还支持键盘快捷键，方便导航。

• DevDocs.io是否免费使用？ 是的，DevDocs.io完全免费使用。这是一个开源项目，这意味着它不仅免费，而且用户还可以参与其开发。这使其成为一个社区驱动的平台，它会根据用户的需求和反馈不断发展。

• DevDocs.io如何确保其文档的准确性？ DevDocs.io直接从官方来源提取其文档，确保所提供的信息准确且最新。该平台还允许用户贡献更正和更新，进一步提高文档的准确性。

• 我可以在离线状态下使用DevDocs.io吗？ 是的，DevDocs.io的主要功能之一是其离线工作能力。用户可以下载他们需要的文档，随时随地访问，无需互联网连接。这使得DevDocs.io成为一个可靠的资源，尤其适合那些可能无法始终连接互联网的开发者。

• 如何为DevDocs.io做出贡献？ 作为一个开源项目，DevDocs.io欢迎用户的贡献。您可以通过报告错误、提出改进建议甚至编写代码来做出贡献。所有贡献所需的信息都可以在DevDocs.io的GitHub页面上找到。

• DevDocs.io是否支持移动设备？ 是的，DevDocs.io完全响应式，并且在移动设备上运行良好。这意味着您可以从智能手机或平板电脑访问所需的文档，使其成为移动开发者的多功能工具。

• DevDocs.io上的文档更新频率如何？ DevDocs.io努力使其文档尽可能最新。更新频率取决于文档的来源。例如，如果官方文档更新了，DevDocs.io将尽快反映这些更改。

• 我可以自定义DevDocs.io的界面吗？ 是的，DevDocs.io允许用户根据自己的喜好自定义界面。您可以选择要显示哪些文档，调整布局，并在浅色和深色主题之间切换。

• DevDocs.io是否支持所有编程语言？ DevDocs.io支持各种编程语言和技术，但它可能并非涵盖所有语言。该平台专注于业界最常用的语言和技术。

• DevDocs.io用户是否有社区或论坛？ 虽然DevDocs.io没有专门的社区或论坛，但用户可以通过该平台的GitHub页面进行互动和贡献。在这里，他们可以报告问题，提出改进建议，并与其他用户和贡献者进行讨论。

所有图片链接均保留原样。

以上是看Devdocs.io的详细内容。更多信息请关注PHP中文网其他相关文章！