Jigsaw 静态站点生成器中如何扩展搜索索引范围

在 Jigsaw 静态站点生成器的博客模板中，默认的搜索功能仅索引博客文章（posts 集合）。然而在实际项目中，我们经常需要将站点根目录下的其他页面也纳入搜索范围。本文将详细介绍如何扩展 Jigsaw 的搜索索引功能。

理解搜索索引生成机制

Jigsaw 博客模板通过事件监听器生成 searchIndex.json 文件，该文件默认只包含 posts 集合中的内容。这个功能由 GenerateIndex.php 监听器实现，它在构建过程中收集指定内容并生成可搜索的 JSON 索引。

扩展搜索索引的方法

方法一：直接修改 GenerateIndex 监听器

我们可以修改 GenerateIndex.php 文件，使其不仅收集 posts 集合，还能收集其他页面：

1. 使用 $jigsaw->getPages() 方法获取所有页面
2. 筛选出需要加入搜索的特定页面
3. 将这些页面转换为搜索索引所需的格式

$pages = collect($jigsaw->getPages())
    ->filter(function ($page) {
        // 只包含特定页面
        return in_array($page->getFilename(), ['index', 'gardening', 'itsupport']);
    })
    ->map(function ($page) use ($jigsaw) {
        return [
            'title' => $page->title,
            'link' => rightTrimPath($jigsaw->getConfig('baseUrl')) . $page->getPath(),
            'snippet' => $page->getExcerpt(),
            'content' => $this->getSearchContent($page),
        ];
    });

$data = $posts->merge($pages)->values();

方法二：创建自定义集合

另一种更结构化的方法是在 config.php 中创建自定义集合：

'collections' => [
    'posts' => [...],
    'searchable_pages' => [
        'extends' => '_pages',
        'items' => [
            ['title' => '首页', 'filename' => 'index'],
            ['title' => '园艺', 'filename' => 'gardening'],
            ['title' => 'IT支持', 'filename' => 'itsupport'],
        ],
    ],
],

然后在 GenerateIndex.php 中同时处理 posts 和 searchable_pages 两个集合。

注意事项

1. 性能考虑：索引过多内容可能会影响搜索性能，建议只索引真正需要搜索的页面
2. 内容格式化：确保所有索引页面都有统一的标题、摘要等元数据
3. 路径处理：注意正确处理基础路径，确保生成的链接正确
4. 构建时间：添加大量内容到搜索索引可能会增加构建时间

最佳实践

对于长期维护的项目，建议采用方法二创建自定义集合，这种方式更加模块化且易于维护。同时，可以为搜索索引中的不同类型内容添加分类标签，便于前端实现更精确的搜索过滤功能。

通过以上方法，我们可以灵活控制 Jigsaw 站点的搜索范围，为用户提供更全面的站内搜索体验。