hexo generator search

ヘキソジェネレーター検索

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 形式のファイルがエクスポートされます。
• フィールド- 検索する検索範囲。以下を選択できます。
  • post (デフォルト) - ブログのすべての投稿のみをカバーします。
  • ページ- ブログのすべてのページのみをカバーします。
  • all - ブログのすべての投稿とページがカバーされます。
• content - 各記事のコンテンツ全体が含まれているかどうか。 falseの場合、生成される結果はタイトルとその他のメタ情報のみをカバーし、本文は含まれません。デフォルトではtrueです。
• template (オプション) - カスタム XML テンプレートへのパス

インデックス作成を除外する

特定の投稿またはページをインデックスから除外するには、前付の先頭に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 ブログでこのプラグインを使用するにはどうすればよいですか?

選択肢は 2 つあります。

• 自分で検索エンジンを書きたくないのです。すぐに使えるローカル検索にこのプラグインを使用するテーマがたくさんあります。
• Ajax と jQuery に精通しており、独自の検索エンジンを作成したいと考えています。私が示したテーマの例に従って、自分で実装することができます。このテーマのソースコードを読んでください。通常、次の 3 つのステップがあります。
  1. 検索ビューを作成します。ここは、検索フォームと検索結果を表示する場所です。
  2. 検索スクリプトを書きます。このスクリプトは、検索データを取得し、検索対象のコンテンツをフィルターで除外する方法をブラウザーに指示します。
  3. hexo に上記 2 つの部分を接続するように指示します。