管理と有効化プラットフォーム内カスタムドキュメントカスタムドキュメントに新しいページを追加する

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

カスタムドキュメントに新しいページを追加する

プラットフォーム内のカスタムドキュメントは Markdown で記述します。カスタムドキュメントバンドルに新しいページを追加するには、ドキュメントリポジトリに新しい Markdown ファイル(.md)を作成し、次の要件を満たしていることを確認してください。

ドキュメントリポジトリ内の各 Markdown ファイル(.md)は、それぞれ独立したドキュメントページとして公開され、バンドルごとにグループ化されて、自動生成される目次からリンクされます。

カスタムドキュメントページの内容を編集するには、Code Repositories を使用してドキュメントリポジトリに新しいブランチを作成し、Markdown ファイルを変更して、変更をコミットしてビルドします。

ページタイトルを指定する

ドキュメントバンドル内のすべてのコンテンツページには、ページタイトルを指定する必要があります。各 Markdown ファイルの先頭に @title 注釈を記述して指定します(@name を使用する overview.md を除きます)。

例:

@title Example title

This is the text of the documentation page named "Example title in sentence case".

実際のファイル名と、@title 注釈で指定するページ名は、同じである必要はありません。

新しいページを ordering.md に追加する

ドキュメントバンドル内の各ページ(必須の overview.md を除きます)は、ドキュメントリポジトリ内の ordering.md ファイルに指定する必要があります。ordering.md では、セクション注釈を使用してドキュメントバンドルを構造化し、整理できます。左側の目次は、これらのセクション注釈をもとに自動生成されます。

ドキュメントバンドルの整理方法について詳しくはこちら。

任意:目次で別のラベルを使用する

コンテンツページのファイル名は、そのページの URL の生成に使用されますが、左側の目次には @title のページタイトルが使用されます。目次のページラベルをページタイトルと異なるものにしたい場合(たとえば、ページタイトルが非常に長い場合)は、@toc 注釈を使用して目次のラベルを指定できます。

上の例を拡張すると、次のようなファイルになります。

@title Example long title in sentence case
@toc Example

This is the text of the documentation page named "Example long title in sentence case". The page's title will appear in the table of contents as "Example".