搜索引擎

Nextra 包含一个全页面搜索功能，使用户可以轻松找到整个文档站点中的相关内容。

Tip

检查迁移指南以获取更多信息。

设置

Nextra 与 Pagefind 集成，这是一个静态搜索库，它索引您的 HTML 文件并提供闪电般的客户端全文本搜索——无需服务器。


npm i -D pagefind


pnpm add -D pagefind


yarn add --dev pagefind


bun add --dev pagefind

Pagefind 索引 .html 文件，因此索引必须在构建应用程序之后发生。

在您的 package.json 中添加一个 postbuild 脚本：

package.json


"scripts": {
  "postbuild": "pagefind --site .next/server/app --output-path public/_pagefind"
}

将 _pagefind/ 添加到您的 .gitignore 文件中，以避免提交生成的索引文件。

在构建并运行 postbuild 脚本后，检查 public/ 或 out/ 中是否存在 _pagefind/ 目录。启动您的应用并测试搜索栏以确认一切正常。

搜索默认启用。您可以通过在 next.config.mjs 文件中设置 search: false 来完全禁用它：

next.config.mjs


import nextra from 'nextra'
 
const withNextra = nextra({
  search: false
})
export default withNextra()

要禁用代码块索引同时保持搜索启用，请设置 search: { codeblocks: false }：

next.config.mjs


import nextra from 'nextra'
 
const withNextra = nextra({
  search: { codeblocks: false }
})
export default withNextra()