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

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

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

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

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

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

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

ドキュメントバンドル内のすべてのコンテンツページには、ページタイトルの指定が必要です。これは、各Markdownファイル(overview.md以外)の先頭に@titleアノテーションを使用して行われます(overview.md@nameを使用します)。

たとえば:

@title Example title

This is the text of the documentation page named "Example title in sentence case".
Copied!
1 2 3 @title 例のタイトル こちらは「例のタイトル(文のケース)」という名前のドキュメントページのテキストです。

実際のファイル名と @title アノテーションで指定されたページ名は同じである必要はありません。

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

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

ドキュメントバンドルの整理方法についてさらに詳しく学びましょう。

任意: 目次に異なるラベルを使用する

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

上記の例を基にすると、次のようなファイルが考えられます:

@title Example long title in sentence case
@toc Example

このページの名前は「Example long title in sentence case」です。ページのタイトルは目次に「Example」として表示されます。