hexo generator search

hexo 生成器搜索

生成 Hexo 3.x 和 4.x 的搜索数据。该插件用于生成搜索索引文件，其中包含文章的所有必要数据，您可以使用这些数据为博客编写本地搜索引擎。支持XML和JSON格式输出。

• 演示 - 尝试此站点中的搜索引擎。
• 演示 JSON 输出
• 演示 XML 输出

安装

$ npm install hexo-generator-search --save

选项

您可以在根_config.yml中配置此插件。

 search :
  path : search.xml
  field : post
  content : true
  template : ./search.xml

• 路径- 文件路径。默认情况下是search.xml 。如果文件扩展名是.json ，则输出格式将为 JSON。否则将导出 XML 格式文件。
• field - 您要搜索的搜索范围，您可以选择：
  • post （默认）- 仅涵盖您博客的所有帖子。
  • 页面- 仅覆盖您博客的所有页面。
  • all - 将涵盖您博客的所有帖子和页面。
• content - 是否包含每篇文章的全部内容。如果为false ，生成的结果仅涵盖标题和其他元信息，而不包含主体。默认情况下为true 。
• template （可选）- 自定义 XML 模板的路径

排除索引

要排除某个帖子或页面被索引，您可以简单地在其 front-matter 顶部插入indexing: false设置，例如：

 title: "Code Highlight"
date: "2014-03-15 20:17:16"
tags: highlight
categories: Demo
description: "A collection of Hello World applications from helloworld.org."
toc: true
indexing: false
---

那么生成的结果将不包含该帖子或页面。

常问问题

这个插件应该做什么？

该插件用于从 Hexo 博客生成 xml / json 文件，以提供搜索数据。

这个文件保存在哪里？

执行hexo g后，您将在公共文件夹中获得生成的结果。

如何在我的 Hexo 博客中使用这个插件？

你有两个选择：

• 你不想自己编写搜索引擎。有许多主题使用此插件进行开箱即用的本地搜索。
• 您熟悉 Ajax 和 jQuery，并希望编写自己的搜索引擎。你可以按照我给出的示例主题自己实现一个。阅读该主题的源代码。一般有3个步骤：
  1. 编写一个搜索视图。这是显示搜索表单和搜索结果的地方；
  2. 编写搜索脚本。该脚本告诉浏览器如何获取搜索数据并过滤掉我们正在搜索的内容；
  3. 告诉hexo连接以上两部分。