FAQ

標準の Markdown とカスタムドキュメントで必要な構文にはどのような違いがありますか？

プラットフォーム内のカスタムドキュメントと標準の Markdown の最も重要な違いは、次のとおりです。

• ページタイトルは、H1 見出し（#）ではなく、@ 構文（overview.md では @name、概要以外のページでは @title）で指定する必要があります。実際のファイル名と @title は同じである必要はありません。
• 正常に公開するには、すべてのページを ordering.md ファイルで指定する必要があります。
• すべてのページにセクション注釈（たとえば、@concept または @howto）が必要です。

プラットフォーム内のカスタムドキュメントは変更履歴に対応していますか？

いいえ、現在、カスタムドキュメントの変更履歴には対応していません。

カスタムドキュメントはブランチに対応していますか？

ドキュメントリポジトリではブランチで作業できますが、プラットフォーム内のカスタムドキュメントに公開されるのは master ブランチのみです。

コールアウトで Markdown の書式設定が表示されないのはなぜですか？

コールアウトは HTML で指定されるため、コールアウト内の <div> と </div> の間では Markdown の書式設定を利用できません。たとえば、コールアウト内のテキストを太字にするには、Markdown 構文の **This is bold text.** ではなく、HTML 構文の <strong>This is bold text.</strong> を使用する必要があります。