为抽屉创建内容

在 GitLab UI 中，你可以在 抽屉组件 中显示帮助内容。 Markdown 的组件位于 故事书 中。

该组件指向一个 Markdown 文件。每次你更新 Markdown 文件时，抽屉中的内容也会更新。

抽屉内容仅在抽屉中显示，不会显示在 docs.gitlab.com 上。 内容使用 Gitlab Flavored Markdown 渲染。

创建此内容的步骤：

1. 在 GitLab 仓库中， 进入 /doc/drawers 文件夹。

2. 创建一个 Markdown 文件。使用描述性的文件名。 不要创建子文件夹。

3. 添加标准的页面元数据。同时包括：

   type: drawer

4. 编写内容。

5. 如果页面包含与 docs.gitlab.com 上某页面相同的内容， 在页面的元数据中，包含另一个文件的路径。例如：

   source: /doc/user/search/global_search/advanced_search_syntax.md

6. 与开发人员合作，在抽屉中查看内容并 验证内容是否正确显示。

抽屉内容指南

• 文件中的标题用作抽屉中的标题。 H1 标题是抽屉的标题。
• H1 中不要包含纯文本以外的任何字符。
• 抽屉组件较窄且不可调整大小。
  • 如果包含表格，表格中的内容应简洁。
  • 虽然技术上没有使用字符数量的限制， 但你应该预览抽屉内容以确保 渲染效果良好。
• 要从抽屉链接到其他内容，请使用绝对 URL。
• 不要包含 Hugo 短代码，如警告框或 SVG 图标。