跳到主要内容

搜索

·5 分钟阅读
echjordan
echjordan
vanessayuenn
vanessayuenn
zeke
zeke

Electron 网站有了一个新的搜索引擎，可以即时提供 API 文档、教程、与 Electron 相关的 npm 包等结果。

Electron Search Screenshot

学习像 Electron 这样的新技术或框架可能会让人感到畏惧。一旦你过了快速入门阶段，就可能很难学习最佳实践、找到合适的 API 或发现可以帮助你构建梦想应用的工具。我们希望 Electron 网站能成为一个更好的工具，帮助你更快更轻松地找到构建应用所需的资源。

访问 electronjs.org 上的任何页面，你都会在页面顶部找到新的搜索输入框。

搜索引擎​

当我们最初开始为网站添加搜索功能时，我们使用 GraphQL 作为后端，推出了我们自己的搜索引擎。GraphQL 用起来很有趣，搜索引擎的性能也不错，但我们很快意识到，构建搜索引擎并非易事。诸如多词搜索和错别字检测之类的事情需要大量工作才能做好。与其重新发明轮子，我们决定使用现有的搜索解决方案：Algolia。

Algolia 是一种托管搜索服务，它已迅速成为 React、Vue、Bootstrap、Yarn 以及 许多其他流行的开源项目的首选搜索引擎。

以下是使 Algolia 非常适合 Electron 项目的一些功能

API 文档​

有时你知道你想完成什么，但你不知道确切的如何去做。Electron 拥有超过 750 个 API 方法、事件和属性。没有人能轻易记住所有这些，但计算机擅长做这些事情。使用 Electron 的 JSON API 文档，我们在 Algolia 中索引了所有这些数据，现在你可以轻松找到你正在寻找的确切 API。

想要调整窗口大小？搜索 resize 并直接跳转到你需要的方法。

教程​

Electron 有一个不断增长的教程集合，以补充其 API 文档。现在你可以更轻松地找到关于特定主题的教程，以及相关的 API 文档。

正在寻找安全最佳实践？搜索 security。

npm 包​

npm 仓库中现在有超过 700,000 个包，找到你需要的包并不总是容易的。为了更容易发现这些模块，我们创建了 electron-npm-packages，它是仓库中 3400 多个专门为与 Electron 一起使用而构建的模块的集合。

Libraries.io 的人们创建了 SourceRank，这是一个基于代码、社区、文档和使用情况等指标的组合来为软件项目评分的系统。我们创建了一个 sourceranks 模块，其中包括 npm 仓库中每个模块的分数，我们使用这些分数来对包结果进行排序。

想要 Electron 内置 IPC 模块的替代方案？搜索 is:package ipc。

Electron 应用​

使用 Algolia 索引数据很容易，所以我们从 electron/apps 添加了现有的应用列表。

尝试搜索 music 或 homebrew。

过滤结果​

如果你以前使用过 GitHub 的 代码搜索，你可能知道它的冒号分隔的键值过滤器，如 extension:js 或 user:defunkt。我们认为这种过滤技术非常强大，所以我们在 Electron 的搜索中添加了一个 is: 关键字，让你过滤结果以仅显示单一类型

键盘导航​

人们喜欢键盘快捷键！新的搜索功能可以在不将手指离开键盘的情况下使用

  • / 聚焦搜索输入框
  • esc 聚焦搜索输入框并清除内容
  • down 移动到下一个结果
  • up 移动到上一个结果，或搜索输入框
  • enter 打开结果

我们还开源了 模块，该模块实现了这种键盘交互。它专为与 Algolia InstantSearch 一起使用而设计，但也经过通用化，以实现与不同搜索实现的兼容性。

我们需要你的反馈​

如果你在使用新的搜索工具时遇到任何问题，我们希望听到你的反馈！

提交反馈的最佳方式是在 GitHub 上在相应的仓库中提交 issue

感谢​

特别感谢 Emily Jordan 和 Vanessa Yuen 构建了这些新的搜索功能，感谢 Libraries.io 提供 SourceRank 分数，并感谢 Algolia 团队帮助我们入门。🍹