跳转到主要内容

搜索

·6 分钟阅读
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 项目理想选择的一些功能：

  • InstantSearch.js 可在输入时提供结果，通常只需 1 毫秒。
  • 拼写容错 意味着即使你输入 widnow 也能获得结果。
  • 高级查询语法 支持 “精确匹配” 和 -排除。
  • API 客户端是开源的，并且文档齐全。
  • 分析 告诉我们人们最常搜索什么，以及他们搜索但找不到的内容。这将为我们改进 Electron 的文档提供宝贵的见解。
  • Algolia 对开源项目是免费的。

API 文档​

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

尝试调整窗口大小？搜索 resize，直接找到你需要的方法。

教程​

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

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

npm 包​

npm 注册表现在有超过 70 万个包，找到你需要的包并不总是那么容易。为了更容易地发现这些模块，我们创建了 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 团队的帮助。🍹