FAQ（常见问题解答（FAQ））¶

What are the differences between standard Markdown and the syntax required for custom docs?¶

The most important differences from standard Markdown in the in-platform custom documentation are:

Page titles must be specified with the @ syntax (@name for overview.md or @title for non-overview pages), instead of an H1 header (#). Note that the actual filename and @title do not need to be the same.
All pages must be specified in the ordering.md file to be published successfully.
All pages must have a section annotation (for example, @concept or @howto).

Does in-platform custom documentation support changelogs?¶

No, changelogs for custom documentation are currently not supported.

Does custom documentation support branching?¶

You can work on branches in a documentation repository, but only the master branch is published to the in-platform custom documentation.

Why does Markdown formatting not display in a callout?¶

Since callouts are designated with HTML, Markdown formatting is not available between the <div> and </div> in the callout; for example, to bold text within a callout you should use the HTML syntax <strong>This is bold text.</strong> rather than the Markdown syntax **This is bold text.**

中文翻译¶

常见问题解答（FAQ）¶

标准 Markdown 与自定义文档所需语法有何区别？¶

平台内自定义文档与标准 Markdown 最重要的区别如下：

页面标题必须使用 @ 语法指定（overview.md 使用 @name，非概览页面使用 @title），而非 H1 标题（#）。请注意，实际文件名与 @title 无需保持一致。
所有页面必须在 ordering.md 文件中指定，才能成功发布。
所有页面必须包含章节注释（section annotation）（例如 @concept 或 @howto）。

平台内自定义文档是否支持更新日志（changelogs）？¶

不支持，目前自定义文档暂不支持更新日志功能。

自定义文档是否支持分支（branching）？¶

您可以在文档仓库中处理分支，但只有 master 分支会发布到平台内自定义文档中。

为什么 Markdown 格式在标注框（callout）中无法显示？¶

由于标注框使用 HTML 定义，因此在 <div> 和 </div> 之间无法使用 Markdown 格式。例如，要在标注框内加粗文本，应使用 HTML 语法 <strong>这是加粗文本。</strong>，而非 Markdown 语法 **这是加粗文本。**