ヘッダーオプション
ドキュメントサイトの上部ナビゲーションバーに何が表示されるかを制御します。
設定#
| 設定 | 機能 |
|---|---|
| ヘッダーを表示 | トップナビゲーションバー全体を表示または非表示にします |
| ヘッダーリンク | ヘッダーナビゲーションのカスタムテキストリンク |
| ソーシャルリンク | GitHub、Twitter、Discordのアイコンリンク |
| ヘッダーのテーマ切り替え | ヘッダーにライト/ダークの切り替えを表示します |
| ヘッダーの言語選択 | ヘッダーに言語切り替えを表示します |
| ヘッダーの検索ボタン | ヘッダーに検索アイコン/ボタンを表示します |
設定方法#
- ドキュメントサイトを開きます。
- フローティングウィジェット → デザイン → ヘッダー タブ。
- フィールドに入力し、オプションを切り替えます。
- 保存します。
ヘッダーリンク#
カスタムナビゲーションリンクをトップバーに追加します。製品、ブログ、変更ログ、またはサポートへのリンクに便利です。
形式: 各リンクには、ラベルとURLがあります。
例:
| ラベル | URL |
|---|---|
| 製品 | https://yourapp.com |
| 変更ログ | https://yourapp.com/changelog |
| サポート | https://yourapp.com/support |
ソーシャルリンク#
コミュニティやソーシャルメディアへのアイコンリンクを追加します。
サポートされているプラットフォーム:
- GitHub — リポジトリまたは組織へのリンク
- Twitter / X — Twitterプロファイルへのリンク
- Discord — コミュニティサーバーへのリンク
ソーシャルリンクは、ヘッダーに小さなアイコンとして表示されます。これにより、読者はナビゲーションにテキストリンクを追加することなく、コミュニティを見つけることができます。
テーマと言語をヘッダーに#
テーマの切り替えボタンと言語切り替えボタンを、サイドバーの代わりに（または追加して）ヘッダーに配置できます。
推奨事項: 各コントロールの配置場所を1つに絞り、重複を避けてください。
- ヘッダー配置: 新規訪問者にとってより見やすく、クリックまでの深さが浅くなります。
- サイドバー配置: ヘッダーのスペースを節約でき、情報量の多いヘッダーに適しています。
ヘッダーの非表示#
ヘッダーを表示をオフにすると、トップナビゲーションバー全体が削除されます。
これは、ドキュメントが別の製品内に組み込まれている埋め込みまたはキオスクの使用例でのみ行ってください。スタンドアロンのドキュメントサイトでは、常にヘッダーを表示してください。
読者を導くナビゲーションを設計してください。 GitHubリポジトリを接続 →