看看DevDocs.io

最新推荐文章于 2025-04-25 19:45:09 发布

dingshi7798

最新推荐文章于 2025-04-25 19:45:09 发布

阅读量295

点赞数

文章标签： php javascript ViewUI

编码时，您多久经历一次以下过程？

需要[在此处插入编程语言]函数定义和示例
谷歌表示功能
单击第一个结果，如果运气不好，可以输入w3schools，也可以单击所使用语言的在线手册。
意识到您需要演示和解释的另一个功能
返回Google而不是在该语言的网站上使用搜索，因为它比新的Google搜索后实际重新加载标签页更令人费解且缓慢
冲洗并重复

作为在很大程度上处理Web技术的开发人员，我已经遇到了很多。仅仅找到功能或语句的技术定义比以往任何时候都更加困难–不仅在复杂性方面，而且在浪费时间方面。如果我们可以将所有开发文档都放在一个地方，并且具有美观，可离线使用的界面以及超快速的模糊搜索功能，对于任何一种语言，这都很棒吗？输入devdocs.io 。

它是什么？

DevDocs是一个Web应用程序，旨在为您提供对几乎所有前端语言和库的参考手册的快速访问。它以易于浏览和查看的格式列出了给定所选语言的所有API及其官方文档，而没有不必要的菜单和俗气的样式来使php.net之类的官方网站尝试发布。

它是Ajax驱动的开源Web应用程序，具有语法突出显示功能，甚至可以作为Chrome扩展程序或Sublime Text或Brackets的插件使用。

enter image description here

它有什么作用？

它汇总了所有流行语言的参考手册（前提是它们的手册以易于访问且可机耗的格式显示）。它为您提供了一个光滑而快速的界面，用于模糊搜索所有选定语言的文档，以便在尽可能少的按键操作中找到所需的信息。您可能想知道什么是模糊搜索？模糊搜索是在寻找与输入内容大致（不完全）匹配的字符串。这就是Sublime Text和LightTable之类的编辑器在其命令搜索窗口中所使用的-输入“ sa”将为您提供“另存为...”，因为输入内容与命令的首字母匹配。输入“ delte”将提供包含“ delta”和“ delete”的结果，输入“ bgcp”甚至会给您“背景剪辑”。这种类型的搜索可以对结果进行超快速的微调，并且由于它们是实时的，因此您可以在现场进行混合和匹配。

enter image description here

内容

DevDocs为您选择的语言下载参考手册的索引，并将其从提供结果的位置吸收到本地缓存中。这确实意味着您必须在每台新机器上重新下载选择的语言，但是通过这种操作方式获得的速度提升远远优于老式的Ajax远程请求处理方式。提醒您-当前，只有索引处于脱机状态，您单击的实际结果是从远程位置提供的-例如，即使搜索结果中显示了JavaScript数组，您仍需要访问Internet才能获取JavaScript数组的文档离线。

enter image description here

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

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

enter image description here

开源和本地

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

enter image description here

DevDocs会定期维护和更新，并提供了各种与时俱进的更改方式：

如果您碰巧在更新日期之前将其保持打开状态，则站点本身将生成具有最新更改的弹出窗口
有一个时事通讯
有一个Twitter帐户
甚至还有一个邮件列表
有一个最新的变更日志

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

其他津贴

DevDocs已针对移动设备进行了全面优化，并且响应速度很快。它会立即打开，并且在移动设备上的功能与在桌面设备上的功能完全相同。它建立了网站始终被构建的方式–在每台设备上都提供流畅，快速且相同的体验。 Thibaut Courouble确实做得很棒。

enter image description here

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

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

还提供了各种键盘快捷键，它们都很直观而且非常有用，可提供真正的流畅体验。

enter image description here

结论

如果您在阅读本文之前没有听说过DevDocs，我强烈建议您尝试一下。 Web迫切需要如此高可用性的资源，因此广为传播，并帮助社区找到更好的解决方案，以解决他们正在处理的问题。如果您可以捐款，DevDocs可以在GitTip上使用，并支持PayPal捐款-但可以说，最好的帮助方法是只使用它，告诉别人有关它，最重要的是，通过为GitHub上的项目捐款来改进它。

From: https://www.sitepoint.com/look-devdocs-io/