3.3. TechDocs でのドキュメントの表示
TechDocs では、1 つのドキュメントが、同じトピックに関連する他のドキュメントを含むブックの一部となっている場合があります。
Documentation ページの表でドキュメントの名前をクリックすると、ブックページでドキュメントが開きます。ブックの名前は、ブックページに表示されます。ブックページには、次の要素が含まれています。
- ドキュメントの内容
- ドキュメント内でキーワード検索に使用できる検索バー
- ブック内の他のドキュメントに移動するために使用できるナビゲーションメニュー
- ドキュメントの他のセクションに移動するために使用できる 目次
- ブック内の次のドキュメントに移動するために使用できる Next ボタン
ブックページの要素を使用して、ブック内のドキュメントを検索、表示、および移動できます。
前提条件
- TechDocs プラグインが有効化され、設定されている。
- ドキュメントが TechDocs にインポートされている。
- TechDocs にドキュメントを追加し、表示するために必要なロールおよびパーミッションがある。
- オプション: TechDocs アドオンがインストールされ、設定されている。
手順
- Red Hat Developer Hub ナビゲーションメニューで、Docs をクリックします。
- Documentation テーブルで、表示するドキュメントの名前をクリックします。
ブックページでは、次のいずれかのオプションのアクションを実行できます。
- デフォルトの TechDocs プラグインの機能を拡張するインストール済みアドオンの使用。
- 検索バーを使用したドキュメント内のキーワードの検索。
以下のいずれかの方法を使用したブック内のドキュメントへの移動。
- 目次 を使用して、ドキュメントの任意のセクションへ移動する。
- ナビゲーションメニューを使用して、ブック内の任意のドキュメントへ移動する。
- Next をクリックして、ブック内の次のドキュメントへ移動する。
関連情報