跳到主要内容

搜索

·阅读 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 项目的功能

  • InstantSearch.js 在你键入时提供结果，通常在 1 毫秒左右。
  • 容错功能意味着即使你键入 widnow，你仍然会得到结果。
  • 高级查询语法启用 "完全匹配" 和 -排除。
  • API 客户端是开源的，并且有详细的文档。
  • 分析会告诉我们人们搜索最多的是什么，以及他们搜索但找不到的是什么。这将为我们提供宝贵的见解，了解如何改进 Electron 的文档。
  • Algolia 对 开源项目免费。

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 团队帮助我们入门。🍹