middleman search

ミドルマン::検索

LunrJS ベースの Middleman 検索。

インストール

次の行をアプリケーションの Gemfile に追加します。

 gem 'middleman-search'

そして、以下を実行します。

 $ bundle

または、次のように自分でインストールします。

 $ gem install middleman-search

使用法

config.rb内のモジュールをアクティブにして、拡張機能にリソースのインデックス付け方法を指示する必要があります。

 activate :search do | search |

  search . resources = [ 'blog/' , 'index.html' , 'contactus/index.html' ]

  search . index_path = 'search/lunr-index.json' # defaults to `search.json`
  
  search . lunr_dirs = [ 'source/vendor/lunr-custom/' ] # optional alternate paths where to look for lunr js files

  search . language = 'es' # defaults to 'en'

  search . fields = {
    title :   { boost : 100 , store : true , required : true } ,
    content : { boost : 50 } ,
    url :     { index : false , store : true } ,
    author :  { boost : 30 }
  }
end

ここで、 resourcesインデックスを作成するリソースの URL の先頭のリスト ( String#start_with?でテスト)、 index_pathはサイト内に生成されたインデックス ファイルの相対パス、 fieldsフィールドごとに 1 つのエントリを持つハッシュです。オプションのハッシュが関連付けられてインデックスが作成されます。

• boostこのフィールドを検索するときに、lunr 関連性ブーストを指定します。
• storeこのフィールドをドキュメント マップ (下記を参照) に保存するかどうか。デフォルトは false です。
• indexこのフィールドにインデックスを付けるかどうか。デフォルトは true
• required必須としてマークされたフィールドの値が空または null の場合、リソースはインデックス付けされません。

特別なフィールドidが自動的に含まれ、自動生成された識別子がドキュメントのrefとして使用されることに注意してください。

すべてのフィールド値は、リソースdata (つまり、そのフロントマター)、またはresource.metadataのoptions (つまり、 proxyページで指定されたオプション) から取得されます。ただし、次の場合は除きます。

• 実際のリソースの URL であるurl
• contentレンダリングされたリソースから抽出されたテキスト (レイアウトは含まれません)

その後、 lunrIndexオブジェクトを介して Javascript からインデックスをクエリできます (詳細については、インデックス ファイルを参照してください)。

 var max_search_entries = 50 ;

var result = [ ] ; //initialize empty array

lunrIndex . search ( request . term ) . forEach ( function ( item , index ) {
  if ( index < max_search_entries ) {
    result . push ( lunrData . docs [ item . ref ] ) ;
  }
} ) ;

(マナスで使用していた lodash v3 コードを適応させてくれた @Jeepler に感謝します)

i18n

この gem には、MihaiValentin/lunr-langages によって提供される代替言語のアセットが含まれています。利用可能な言語のリストについては、そのリポジトリを参照してください。

含まれていない言語を使用する場合は、プロジェクト内のフォルダーにlunr.yourlang.jsファイルをセットアップし、そのフォルダーをlunr_dirsに追加して、Gem がどこを検索すればよいかを認識できるようにします。

手動インデックス操作

before_indexコールバックを定義することで、リソースごとにインデックスを作成して保存するコンテンツを完全にカスタマイズできます。

 activate :search do | search |
  search . before_index = Proc . new do | to_index , to_store , resource |
    if author = resource . data . author
      to_index [ :author ] = data . authors [ author ] . name
    end
  end
end

このオプションは、リソースごとに実行されるコールバックを受け入れます。コールバックは、リソースだけでなく、出力のindexオブジェクトとdocsオブジェクトにそれぞれインデックス付けされるドキュメントと保存されるマップを使用して実行されます。処理中です。このコールバックを使用してそれらのいずれかを変更することも、 throw(:skip)使用して問題のリソースをスキップすることもできます。

Lunrパイプライン構成

場合によっては、インデックス作成と検索の両方のために、lunr パイプラインに新しい関数を追加することができます。これを行うには、次のように関数名と本体を含むpipelineハッシュを提供します。

 activate :search do | search |
  search . pipeline = {
    tildes : <<-JS
      function(token, tokenIndex, tokens) {
        return token
          .replace('á', 'a')
          .replace('é', 'e')
          .replace('í', 'i')
          .replace('ó', 'o')
          .replace('ú', 'u');
      }
    JS
  }
end

これにより、 tildes関数が lunr パイプラインに登録され、インデックスの構築時に追加されます。 Lunr ドキュメントから:

パイプライン内の関数は、処理中の現在のトークンという 3 つの引数を使用して呼び出されます。トークンの配列内のそのトークンのインデックス、および処理されるドキュメントの一部であるトークンのリスト全体。これにより、トークンの単純なユニグラム処理だけでなく、より高度な N グラム処理も可能になります。

この関数はテキストの処理されたバージョンを返す必要があり、それがパイプライン内の次の関数に渡されます。未定義を返すと、それ以上のトークンの処理が妨げられ、そのトークンはインデックスに登録されなくなります。

パイプラインに関数を追加すると、インデックスのシリアル化解除時にその関数もロードされ、再登録されていない場合、lunr は「 Cannot load un-registered function: tildes 。これらを手動で登録することも、インデックスをロードする前に実行される.js.erbファイルに次のコードを含めることもできます。

 <%= search_lunr_js_pipeline %> 

インデックスファイル

生成されたインデックス ファイルには、次の 2 つのプロパティを持つ JSON オブジェクトが含まれています。

• indexシリアル化された lunr.js インデックスが含まれており、これはlunr.Index.load(lunrData.index)経由でロードできます。
• docs自動生成されたドキュメント ID から、ストレージ用に構成された属性を含むオブジェクトへのマップです。

通常は、 index lunr インデックス インスタンスにロードし、 docsマップを使用して戻り値を検索し、ユーザーに表示します。

実際にインデックスをロードできるようにするには、メインの sprockets JavaScript ファイル (アセット パイプラインを使用している場合) にlunr.min.jsファイルもrequireです。

 //= require lunr.min

lunr の i18n 機能を使用している場合は、Stemmer サポートと言語ファイルも (この順序で) ここでロードする必要があります。

 //= require lunr.min
//= require lunr.stemmer.support
//= require lunr.es

アセットパイプライン

Middleman パイプライン (有効な場合) には、デフォルトではjsonファイルが含まれませんが、 gzipやasset_hashなどの対応する拡張子のextsオプションに.jsonを追加することで、これを簡単に変更できます。

 activate :asset_hash do | asset_hash |
  asset_hash . exts << '.json'
end

アセット ハッシュ拡張子を介してインデックス json ファイルを実行する場合は、検索のためにブラウザにファイルをロードするときに、 search_index_pathビュー ヘルパーを使用して実際の宛先 URL を取得する必要があることに注意してください。

 var lunrIndex = null ;
var lunrData  = null ;

// Download index data
$ . ajax ( {
  url : "<%= search_index_path %>" ,
  cache : true ,
  method : 'GET' ,
  success : function ( data ) {
    lunrData = data ;
    lunrIndex = lunr . Index . load ( lunrData . index ) ;
  }
} ) ; 

謝辞

深く感謝します:

• Octo-Labs のmiddleman-alias拡張機能用のジャグザドラム。これを開発するために使用しました。
• jnovos と 256dpi、 middleman-lunrjsおよびmiddleman-lunr拡張機能。これを作成する際のインスピレーションとなりました。
• olivernn とすべてのlunr.js貢献者
• Lunr 言語で 10 以上の言語をサポートしてくださった MihaiValentin。
• Middleman チームと貢献者