文档冒烟测试页面

此页面有两个目的

• 演示 Kubernetes 文档如何使用 Markdown
• 提供一个“烟雾测试”文档，我们可以用它来测试影响整体文档的 HTML、CSS 和模板更改。

标题级别

上面的标题是 H2。页面标题渲染为 H1。以下各节显示 H3 - H6。

### H3

This is in an H3 section.

#### H4

This is in an H4 section.

##### H5

This is in an H5 section.

###### H6

This is in an H6 section.

生成

H3

这是 H3 部分。

H4

这是 H4 部分。

H5

这是 H5 部分。

H6

这是 H6 部分。

内联元素

内联元素显示在段落、列表项、提醒或其它块级元素内的文本中。

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum。

内联文本样式

您可以在 markdown 中使用不同的文本样式，例如

- **bold**
- _italic_
- ***bold italic***
- ~~strikethrough~~
- <u>underline</u>
- _<u>underline italic</u>_
- **<u>underline bold</u>**
- ***<u>underline bold italic</u>***
- `monospace text`
- **`monospace bold`**

生成

• 粗体
• 斜体
• 粗斜体
• 删除线
• 下划线
• 下划线斜体
• 下划线粗体
• 下划线粗斜体
• 等宽文本
• 等宽粗体

列表

Markdown 对列表的处理没有严格的规则。当我们从 Jekyll 迁移到 Hugo 时，我们破坏了一些列表。要修复它们，请记住以下几点

• 确保将子列表项缩进 2 个空格。

• 要结束一个列表并开始另一个列表，您需要在列表之间的新行上放置一个 HTML 注释块，该块与左边框对齐。否则，第一个列表将不会结束，无论您在它和第二个列表之间有多少空行。

项目符号列表

您可以在 markdown 中添加项目符号列表，如下所示：

- This is a list item.
* This is another list item in the same list.
- You can mix `-` and `*`.
  - To make a sub-item, indent two spaces.
    - This is a sub-sub-item. Indent two more spaces.
  - Another sub-item.

生成

• 这是一个列表项。

• 这是同一列表中的另一个列表项。

• 您可以混合使用 - 和 *。
  • 要创建子项，请缩进两个空格。
    • 这是子子项。再缩进两个空格。
  • 另一个子项。

同样,

• 这是一个新列表。使用 Hugo，您需要使用 HTML 注释来分隔两个连续的列表。HTML 注释必须靠左对齐。

• 项目符号列表可以包含段落或块级元素。

  将内容缩进与项目符号的第一个字符对齐。此段落和代码块与上面“Bullet”中的第一个 B 对齐。

  ls -l
  

  • 在一些块级内容之后还有子列表

• 项目符号列表项可以包含编号列表。

  1. 编号子列表项 1
  2. 编号子列表项 2

编号列表

1. 这是一个列表项。
2. 这是同一列表中的另一个列表项。您在 Markdown 中使用的数字不一定对应于最终输出中的数字。按照惯例，我们保持它们同步。

1. 这是一个新列表。使用 Hugo，您需要使用 HTML 注释来分隔两个连续的列表。HTML 注释必须靠左对齐。

2. 编号列表可以包含段落或块级元素。

   将内容缩进与项目符号的第一个字符对齐。此段落和代码块与上面“Numbered”中的 N 对齐。

   ls -l
   

   • 在一些块级内容之后还有子列表。尽管缩进更多，但它与上面的段落和代码块在同一“级别”。

选项卡列表

选项卡列表可用于条件性地显示内容，例如，当需要记录多个选项，但这些选项需要不同的说明或上下文时。

• 选择一个...
• 格式化选项卡列表
• 嵌套标题

echo 'Tab lists may contain code blocks!'

清单

清单在技术上是项目符号列表，但项目符号被 CSS 隐藏了。

• 这是一个清单项
• 这是一个已选中的清单项

代码块

您可以通过在代码块前后用三个反引号字符环绕来创建代码块。仅对代码块使用反引号（代码围栏）。 这允许您指定代码的语言，从而启用语法高亮。它也比使用缩进更可预测。

this is a code block created by back-ticks

反引号方法有一些优点。

• 它几乎总是有效。
• 在查看源代码时更紧凑。
• 它允许您指定代码块的语言，用于语法高亮。
• 它有一个明确的结尾。有时，缩进方法在某些语言（如 Python 或 YAML）中会因为间距的显著性而中断。

要指定代码块的语言，请将其放在第一个反引号组的后面

ls -l

Kubernetes 文档代码块中常用的语言包括

• bash / shell (两者功能相同)
• go
• json
• yaml
• xml
• none (禁用代码块的语法高亮)

包含 Hugo 短代码的代码块

要像上面的示例一样显示原始 Hugo 短代码，并防止 Hugo 解释它们，请在 < 和 > 字符之间使用 C 风格的注释。以下示例说明了这一点（请查看此页面的 Markdown 源代码）。

{{< alert color="warning" >}}This is a warning.{{< /alert >}}

链接

要格式化链接，请将链接文本放在方括号内，后跟括号中的链接目标。

• [链接到 Kubernetes.io](https://kubernetes.ac.cn/) 或
• [相对链接到 Kubernetes.io](/)

您也可以使用 HTML，但不推荐。例如，<a href="https://kubernetes.ac.cn/">链接到 Kubernetes.io</a>。

镜像

要格式化图像，请使用与 链接 类似的语法，但添加一个前导 ! 字符。方括号包含图像的 alt 文本。尽量始终使用 alt 文本，以便使用屏幕阅读器的用户可以从图像中受益。

![pencil icon](/images/pencil.png)

生成

要指定扩展属性，如宽度、标题、说明文字等，请使用 figure 短代码，这比使用 HTML <img> 标签更受欢迎。另外，如果您需要图像也作为超链接，请使用 link 属性，而不是像下面那样将整个 figure 包装在 Markdown 链接语法中。

即使您选择不使用 figure 短代码，图像也可以是链接。这次，铅笔图标链接到 Kubernetes 网站。外部方括号包含整个图像标签，链接目标在末尾的括号中。

[![pencil icon](/images/pencil.png)](https://kubernetes.ac.cn)

生成

您也可以使用 HTML 来创建图像，但不推荐。

<img src="/images/pencil.png" alt="pencil icon" />

生成

表格

简单表格每行一个，列由 | 字符分隔。标题与正文之间的分隔是通过仅包含至少三个 - 字符的单元格完成的。为了方便维护，请尽量保持所有单元格分隔符对齐，即使您需要使用额外的空格。

标题是可选的。任何用 | 分隔的文本都将呈现为表格。

Markdown 表格在单元格内包含块级元素（如列表项、代码块或多个段落）时存在困难。对于复杂或非常宽的表格，请改用 HTML。

<table>
<thead>
  <tr>
    <th>Heading cell 1</th>
    <th>Heading cell 2</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>Body cell 1</td>
    <td>Body cell 2</td>
  </tr>
</tbody>
</table>

生成

Mermaid 可视化

您可以使用 Mermaid JS 可视化。Mermaid JS 版本在 /layouts/partials/head.html 中指定

{{< mermaid >}}
graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;
{{</ mermaid >}}

生成

{{< mermaid >}}
sequenceDiagram
    Alice ->> Bob: Hello Bob, how are you?
    Bob-->>John: How about you John?
    Bob--x Alice: I am good thanks!
    Bob-x John: I am good thanks!
    Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

    Bob-->Alice: Checking with John...
    Alice->John: Yes... John, how are you?
{{</ mermaid >}}

生成

您可以在官方文档中查看更多 示例。

侧边栏和提示

侧边栏和提示提供了为文本添加视觉重要性的方法。请谨慎使用它们。

侧边栏

侧边栏在视觉上偏移文本，但没有 提示 那样醒目。

这是一个侧边栏。

您可以在侧边栏内拥有段落和块级元素。

您甚至可以拥有代码块。

sudo dmesg

提示

提示（注释、警告等）使用 Hugo 短代码。

包含

将短代码添加到包含项。

Katacoda 嵌入式实时环境