FAQ

標準Markdownとカスタムドキュメントに必要な構文の違いは何ですか？

プラットフォーム内のカスタムドキュメントにおける標準Markdownとの最も重要な違いは以下の通りです:

• ページタイトルはH1ヘッダー (#) の代わりに @ 構文 (overview.md では @name、非overviewページでは @title) を使用して指定する必要があります。実際のファイル名と @title は同じである必要はありません。
• すべてのページは ordering.md ファイルで指定する必要があり、これによって成功裏に公開されます。
• すべてのページにはセクションアノテーション（たとえば、@concept や @howto）が必要です。

プラットフォーム内のカスタムドキュメントは変更ログをサポートしていますか？

いいえ、カスタムドキュメントの変更ログは現在サポートされていません。

カスタムドキュメントはブランチをサポートしていますか？

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

カスタムドキュメントエディタはMarkdownプレビューをサポートしていますか？

はい。Split vertically オプションを使用し、Toggle render Markdown をオンにすると、Markdownファイルをプレビューと並べて表示できます。

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

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