docusaurus search local
v1.2.0
ファイアウォールの内側で動作する Docusaurus v2+のオフライン/ローカル検索。
機能のハイライト:
注: 検索ボックスにはオープン ソースの algolia/autocomplete ライブラリを使用します。このライブラリはフロントエンドとしてのみ使用され、デフォルトの Docusaurus 検索エクスペリエンス (algolia/docsearch) とは異なり、 Algolia サーバーやサードパーティ サーバーには接続しません。
npm install @cmfcmf/docusaurus-search-localまたは
yarn add @cmfcmf/docusaurus-search-localこのプラグインをdocusaurus.config.jsのplugins配列に追加します。
module . exports = {
// ...
plugins : [ require . resolve ( "@cmfcmf/docusaurus-search-local" ) ] ,
// or, if you want to specify options:
// ...
plugins : [
[
require . resolve ( "@cmfcmf/docusaurus-search-local" ) ,
{
// Options here
} ,
] ,
] ,
} ;次のオプションが利用可能です (デフォルトは以下に示されています)。
{
// whether to index docs pages
indexDocs : true ,
// Whether to also index the titles of the parent categories in the sidebar of a doc page.
// 0 disables this feature.
// 1 indexes the direct parent category in the sidebar of a doc page
// 2 indexes up to two nested parent categories of a doc page
// 3...
//
// Do _not_ use Infinity, the value must be a JSON-serializable integer.
indexDocSidebarParentCategories : 0 ,
// Includes parent categories path in search result
includeParentCategoriesInPageTitle : false ,
// whether to index blog pages
indexBlog : true ,
// whether to index static pages
// /404.html is never indexed
indexPages : false ,
// language of your documentation, see next section
language : "en" ,
// setting this to "none" will prevent the default CSS to be included. The default CSS
// comes from autocomplete-theme-classic, which you can read more about here:
// https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-theme-classic/
// When you want to overwrite CSS variables defined by the default theme, make sure to suffix your
// overwrites with `!important`, because they might otherwise not be applied as expected. See the
// following comment for more information: https://github.com/cmfcmf/docusaurus-search-local/issues/107#issuecomment-1119831938.
style : undefined ,
// The maximum number of search results shown to the user. This does _not_ affect performance of
// searches, but simply does not display additional search results that have been found.
maxSearchResults : 8 ,
// lunr.js-specific settings
lunr : {
// When indexing your documents, their content is split into "tokens".
// Text entered into the search box is also tokenized.
// This setting configures the separator used to determine where to split the text into tokens.
// By default, it splits the text at whitespace and dashes.
//
// Note: Does not work for "ja" and "th" languages, since these use a different tokenizer.
tokenizerSeparator : / [s-]+ / ,
// https://lunrjs.com/guides/customising.html#similarity-tuning
//
// This parameter controls the importance given to the length of a document and its fields. This
// value must be between 0 and 1, and by default it has a value of 0.75. Reducing this value
// reduces the effect of different length documents on a term’s importance to that document.
b : 0.75 ,
// This controls how quickly the boost given by a common word reaches saturation. Increasing it
// will slow down the rate of saturation and lower values result in quicker saturation. The
// default value is 1.2. If the collection of documents being indexed have high occurrences
// of words that are not covered by a stop word filter, these words can quickly dominate any
// similarity calculation. In these cases, this value can be reduced to get more balanced results.
k1 : 1.2 ,
// By default, we rank pages where the search term appears in the title higher than pages where
// the search term appears in just the text. This is done by "boosting" title matches with a
// higher value than content matches. The concrete boosting behavior can be controlled by changing
// the following settings.
titleBoost : 5 ,
contentBoost : 1 ,
tagsBoost : 3 ,
parentCategoriesBoost : 2 , // Only used when indexDocSidebarParentCategories > 0
}
}検索バーを使用してドキュメントを検索できるようになりました。
重要: 検索は、静的にビルドされたドキュメントに対してのみ機能します (つまり、 npm run docusaurus build )。
開発中は検索が機能しません (つまり、 npm run docusaurus startを実行している場合)。ローカルで検索をテストする場合は、まずnpm run docusaurus buildを使用してドキュメントをビルドし、次にnpm run docusaurus serve介してドキュメントを提供します。
ドキュメントが英語で書かれていない場合は、 languageオプションを使用してください。単一の言語を指定することも、複数の言語の配列を指定することもできます。次の言語が利用可能です。
ar, da, de, en, es, fi, fr, hi, hu, it, ja, nl, no, pt, ro, ru, sv, th, tr, vi, zh
重要: 中国語 ( zh ) をサポートするには、 ^2.5.0 || ^3.0.0にnodejieba npm パッケージもインストールする必要があります。 ^2.5.0 || ^3.0.0 。
公式 Docusaurus ドキュメント プラグインで作成されたドキュメント バージョンがサポートされています。ドキュメント ページ上にないとき (ブログ投稿や静的ページを見ているときなど)、検索バーはデフォルトで最新バージョン ( nextではなく、 versions.jsonで定義された最新バージョン) になります。ユーザーがドキュメント ページにアクセスすると、そのバージョンがページから抽出され、検索ではそのバージョンのドキュメントのみが検索されます。検索バーのプレースホルダー テキストには、現在検出されているドキュメントのバージョンが常に反映されます。
このプラグインは、すぐに使える Docusaurus i18n を使用したドキュメントをサポートします。 codeTranslations サブフォルダーに新しい翻訳ファイルを作成し、PR を送信して、追加の翻訳に貢献してください。
cmfcmf/dsl で始まる<yourfolder>/i18n/<locale>/code.json内の翻訳を変更して、翻訳を調整することもできますcmfcmf/dsl. 。詳細については、https://docusaurus.io/docs/i18n/tutorial#translate-json-files をご覧ください。
ドキュメントのビルド中にエラーが発生した場合は、デバッグ モードでドキュメントをビルドして、どのページがエラーの原因となっているかを特定できます。これを行うには、ドキュメントを構築するときにDEBUG環境変数を設定するだけです: DEBUG=1 npm run docusaurus build 。
詳細については、CONTRIBUTING.md ファイルを参照してください。
マサチューセッツ工科大学
