コンテンツにスキップ
Starlight

サイト内検索

Starlightサイトには、デフォルトでPagefindによる全文検索機能が組み込まれています。Pagefindは、静的サイト向けの高速で通信量が少ない検索ツールです。

検索機能を有効にするための設定は必要ありません。サイトをビルドしてデプロイすれば、サイトヘッダーの検索バーを使ってコンテンツを検索できます。

検索結果からコンテンツを隠す

ページを除外する

検索インデックスからページを除外するには、ページのフロントマターにpagefind: falseを追加します。

src/content/docs/not-indexed.md
---
title: 検索結果から隠したいコンテンツ
pagefind: false
---

ページの一部を除外する

Pagefindは、data-pagefind-ignore属性をもつ要素内のコンテンツを無視します。

以下の例では、最初の段落は検索結果に表示されますが、<div>の中身は表示されません。

src/content/docs/partially-indexed.md
---
title: 部分的にインデックスされるページ
---


このテキストは検索で見つかります。


<div data-pagefind-ignore>


このテキストは検索結果から隠されます。


</div>

その他の検索プロバイダ

Algolia DocSearch

AlgoliaのDocSearchプログラムにアクセスでき、Pagefindの代わりにそれを使いたい場合は、公式のStarlight DocSearchプラグインを使うことができます。

  1. @astrojs/starlight-docsearchをインストールします。

    Terminal window
    npm install @astrojs/starlight-docsearch

  2. astro.config.mjsでStarlightのplugins設定にDocSearchを追加し、AlgoliaのappId、apiKey、indexNameを渡します。

    astro.config.mjs
    import { defineConfig } from 'astro/config';
    import starlight from '@astrojs/starlight';
    import starlightDocSearch from '@astrojs/starlight-docsearch';
    

    export default defineConfig({
      integrations: [
        starlight({
          title: 'DocSearchを使ったサイト',
          plugins: [
            starlightDocSearch({
              appId: 'YOUR_APP_ID',
              apiKey: 'YOUR_SEARCH_API_KEY',
              indexName: 'YOUR_INDEX_NAME',
            }),
          ],
        }),
      ],
    });

このように設定を更新すると、サイトの検索バーはデフォルトの検索モーダルではなく、Algoliaのモーダルを開きます。

DocSearch UIを翻訳する

DocSearchはデフォルトで英語のUI文字列のみを提供しています。Starlightの組み込みの国際化の仕組みを使って、モーダルのUIを翻訳できます。

  1. src/content/config.tsで、Starlightのi18nコンテンツコレクション定義をDocSearchスキーマにより拡張します。

    src/content/config.ts
    import { defineCollection } from 'astro:content';
    import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';
    import { docSearchI18nSchema } from '@astrojs/starlight-docsearch/schema';
    

    export const collections = {
      docs: defineCollection({ schema: docsSchema() }),
      i18n: defineCollection({
        type: 'data',
        schema: i18nSchema({ extend: docSearchI18nSchema() }),
      }),
    };

  2. src/content/i18n/のJSONファイルに翻訳を追加します。

    以下はDocSearchで使われる英語のデフォルトです。

    src/content/i18n/en.json
    {
      "docsearch.searchBox.resetButtonTitle": "Clear the query",
      "docsearch.searchBox.resetButtonAriaLabel": "Clear the query",
      "docsearch.searchBox.cancelButtonText": "Cancel",
      "docsearch.searchBox.cancelButtonAriaLabel": "Cancel",
    

      "docsearch.startScreen.recentSearchesTitle": "Recent",
      "docsearch.startScreen.noRecentSearchesText": "No recent searches",
      "docsearch.startScreen.saveRecentSearchButtonTitle": "Save this search",
      "docsearch.startScreen.removeRecentSearchButtonTitle": "Remove this search from history",
      "docsearch.startScreen.favoriteSearchesTitle": "Favorite",
      "docsearch.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites",
    

      "docsearch.errorScreen.titleText": "Unable to fetch results",
      "docsearch.errorScreen.helpText": "You might want to check your network connection.",
    

      "docsearch.footer.selectText": "to select",
      "docsearch.footer.selectKeyAriaLabel": "Enter key",
      "docsearch.footer.navigateText": "to navigate",
      "docsearch.footer.navigateUpKeyAriaLabel": "Arrow up",
      "docsearch.footer.navigateDownKeyAriaLabel": "Arrow down",
      "docsearch.footer.closeText": "to close",
      "docsearch.footer.closeKeyAriaLabel": "Escape key",
      "docsearch.footer.searchByText": "Search by",
    

      "docsearch.noResultsScreen.noResultsText": "No results for",
      "docsearch.noResultsScreen.suggestedQueryText": "Try searching for",
      "docsearch.noResultsScreen.reportMissingResultsText": "Believe this query should return results?",
      "docsearch.noResultsScreen.reportMissingResultsLinkText": "Let us know."
    }