hexo generator searchdb

非推奨: ここに新しいリポジトリがあります

hexo-generator-searchdb

Hexo 用の検索データ生成プラグイン。

このプラグインは、検索インデックス ファイルを生成するために使用されます。このファイルには、ブログのローカル検索エンジンを作成するために使用できる記事の必要なデータがすべて含まれています。 XML 形式と JSON 形式の両方の出力をサポートします。

インストール

$ npm install hexo-generator-searchdb

オプション

このプラグインはルート_config.ymlで設定できます。すべての引数はオプションです。

 search :
  path : search.xml
  field : post
  content : true
  format : html

• パス- ファイルパス。デフォルトはsearch.xmlです。ファイル拡張子が.jsonの場合、出力形式は JSON になります。それ以外の場合は、XML 形式のファイルがエクスポートされます。
• フィールド- 検索する検索範囲。以下を選択できます。
  • post (デフォルト) - ブログのすべての投稿のみをカバーします。
  • ページ- ブログのすべてのページのみをカバーします。
  • all - ブログのすべての投稿とページをカバーします。
• content - 各記事のコンテンツ全体が含まれているかどうか。 falseの場合、生成される結果はタイトルとその他のメタ情報のみをカバーし、本文は含まれません。デフォルトではtrueです。
• format - ページコンテンツの形式。オプションは次のとおりです。
  • html (デフォルト) - 縮小される元の HTML 文字列。
  • ストリップタグ- 元の HTML 文字列が縮小され、すべてのタグが削除されます。
  • raw - 各投稿またはページのマークダウン テキスト。

よくある質問

このプラグインは何をするものなのでしょうか?

このプラグインは、検索用のデータを提供する Hexo ブログから xml / json ファイルを生成するために使用されます。

このファイルはどこに保存されますか?

hexo g実行すると、生成された結果がパブリック フォルダーに取得されます。

Hexo ブログでこのプラグインを使用するにはどうすればよいですか?

選択肢は 2 つあります。

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