検索オプション
訪問者がドキュメントを検索する方法を設定します。
設定#
| 設定項目 | 表示される場所 |
|---|---|
| 検索ボタン | トップのヘッダーバー内 |
| サイドバー検索 | 左側のサイドバーパネル内 |
How to Configure#
ヘッダー検索ボタンの設定: Float Widget → Design → Header タブ → Search button をトグル。
サイドバー検索の設定: Float Widget → Design → Left Sidebar タブ → Search in sidebar をトグル。
Which to Use?#
両方のオプションが利用可能です。ただし、通常は1つの場所を有効にすれば十分です。
| Placement | Best for |
|---|---|
| Header | Most discoverable for first-time visitors |
| Sidebar | Power users who navigate the sidebar frequently |
両方を有効にしても問題ありません。デザインの好みによります。ヘッダーがすでにリンクで混雑している場合は、サイドバー検索がすっきりとした代替手段となります。
検索の仕組み#
Docsbook は、リポジトリ内のすべての Markdown コンテンツをインデックス化します。ドキュメントが GitHub で変更されると、検索インデックスは自動的に更新されます。
検索範囲:
- ページタイトル
- 見出し
- 本文
コードブロックはインデックス化されますが、散文コンテンツよりもランクが低くなります。
読者がすぐに回答を見つけられるように支援します。 GitHub リポジトリを接続 →