metalsmith algoliaダウンロード - metalsmith algoliaソースコードのダウンロード

metalsmith algolia

その他のソースコード

1.0.0

ダウンロード

インストール
使用法
- JavaScript API
- テンプレートのメタデータ
- インデックス付きドキュメント
インデックス付きドキュメントをカスタマイズする
オプションのリファレンス
トドリスト

金属細工師アルゴリア

Algolia のコンテンツにインデックスを付けるための metalsmith プラグイン

このプラグインを使用すると、金属細工師の構築プロセスで Algolia 検索エンジンのコンテンツにインデックスを付けることができます。

このプラグインがニーズに合わない場合は、遠慮なく機能リクエストをお願いします。

インストール

npm install --save metalsmith-algolia

使用法

JavaScript API

以下の例は、コンテンツのインデックスを作成するために必要な最小限のコードを示しています。 (ノード: metalsmith-markdown は必要ありません)

 const metalsmith = require ( 'metalsmith' ) ;
const markdown = require ( 'metalsmith-markdown' ) ;
const algolia = require ( 'metalsmith-algolia' ) ;

metalsmith ( __dirname )
  . source ( './src' )
  . use ( markdown ( ) )
  . use ( algolia ( {
    projectId : '<algolia-project-id>' ,
    privateKey : '<algolia-private-key>' ,
    index : '<algolia-index>'
  } ) )
  . build ( ) ;

コマンドライン引数または環境変数を使用して、アルゴリズム秘密キーを保存してください。

テンプレートのメタデータ

これは、偽のマークダウンテンプレート./src/mypage.mdを使用した例です。

 ---
title : My awesome static page !
description : This is a exemple page
algolia : true
---
# My awesome static page !
content exemple

インデックス付きドキュメント

デフォルトでは、メタデータ(文字列/ブール/整数)とコンテンツは、 algolia: trueメタデータを持つすべてのファイルの Algolia に送信されます。
この例では、生成されるドキュメントは次のようになります。

{
  "title" : " My awesome static page ! " ,
  "description" : " This is a exemple page " ,
  "contents" : " <h1>My awesome static page ! n <p>content exemple</p> "
}

インデックス付きドキュメントをカスタマイズする

コンテンツをクリーンアップしたり、追加のフィールドを計算したり、インデックス作成からメタデータを削除したりする必要がある場合は、コンストラクターをプラグインするfileParserオプションを使用して、独自のドキュメントを生成するためのカスタムコールバックを与えることができます。

 const metalsmith = require ( 'metalsmith' ) ;
const markdown = require ( 'metalsmith-markdown' ) ;
const algolia = require ( 'metalsmith-algolia' ) ;
const cheerio = require ( 'cheerio' ) ;

function customFileParser ( file , metadata ) {
  let documents = [ ] ;
  let $ = cheerio . load ( metadata . contents . toString ( ) ) ;

  // add as many as documents as you need
  documents . push ( {
    title : metadata . title ,
    contents : $ ( 'p' ) . text ( ) ;
  } )

  return documents ;
}

metalsmith ( __dirname )
  . source ( './src' )
  . use ( markdown ( ) )
  . use ( algolia ( {
    projectId : '<algolia-project-id>' ,
    privateKey : '<algolia-private-key>' ,
    index : '<algolia-index>' ,
    fileParser : customFileParser
  } ) )
  . build ( ) ;

今回、生成されるドキュメントは次のようになります。

{
  "title" : " My awesome static page ! " ,
  "contents" : " content exemple "
}

オプションのリファレンス

名前	デフォルト	説明
`projectId`		(必須) Algolia プロジェクト識別子
`privateKey`		(必須) Algolia 秘密キー
`index`		(必須) * アルゴリアインデックス
`clearIndex`	間違い	新しいドキュメントのインデックスを作成する前に Algolia インデックスをクリアする
`fileParser`	ヌル	ドキュメントを構築するためのカスタムハンドラーへの関数参照
`pattern`	*/	入力ファイルと照合するグロブパターン。配列または単一の文字列を指定できます