メインコンテンツまでスキップ

ページレイアウト設定

機能概要

ページレイアウト設定により、ユーザーは上部ナビゲーション、左側の目次スタイル、トップ通知、フッターバナーを追加することで、オンラインドキュメントをカスタマイズすることができます。

ご案内:

近い未来は、より多くのコンポーネントをサポートする予定があります。例えば、左側目次エリア、右側目次エリアや右下エリアにより豊富なコンポーネントが追加される予定があります。

モジュール

現在、4つのモジュールに対応しています:上部ナビゲーション、左側目次スタイル、トップ通知、およびフッターバナーエリアです。`

apidog

1. 上部ナビゲーション

カスタムナビゲーションメニューを編集するには、3つのオプションが利用可能です。

APIフォルダを指定: 全てのAPIを選択可能

カスタムリンク: カスタムテキストをサポート

多段階目次: サブメニューをサポート

apidog

2. ボタンコンポーネント

上部ナビゲーションの右側の機能領域では、ボタンコンポーネントの追加をサポートしています。今後は、アイコンテキスト検索ボックスライト/ダークモードのスイッチなどのコンポーネントを追加する予定です。

apidog

3. 左側の目次スタイル

上部ナビゲーション左側の目次スタイルを同時に有効にすることができません。上部ナビゲーションを有効にする場合、左側の目次スタイルが自動的に無効になります。左側の目次スタイルを利用するには、まずは上部ナビゲーションを無効にする必要があります。

apidog

全て開くの効果:

adada

第一レベルの目次をたたむの効果:

adada

4. APIドキュメントのフッターバナーエリア

現在、広告画像コンポーネントがサポートされています。このコンポーネントを使用すると、ドキュメントの底部にプロモーション用の画像を追加することができます。

apidog