跳到主要内容

搜索

·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 注册表现在有超过 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 上的相应仓库中提交问题

感谢​

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