From a49af9f466c9d1e677fc50c41721c2c1d1a92b23 Mon Sep 17 00:00:00 2001 From: LiuDui <1693291525@qq.com> Date: Sun, 16 Jun 2019 21:18:08 +0800 Subject: [PATCH] ZH-trans: add test.md (#13297) * Create test.md * Update test.md * Update test.md * Update test.md * Update test.md * Update test.md * Update test.md --- content/zh/docs/test.md | 707 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 707 insertions(+) create mode 100644 content/zh/docs/test.md diff --git a/content/zh/docs/test.md b/content/zh/docs/test.md new file mode 100644 index 0000000000..da0050d780 --- /dev/null +++ b/content/zh/docs/test.md @@ -0,0 +1,707 @@ +--- +title: 文档冒烟测试页面 +main_menu: false +--- + + + + +此文档有两个用途: + + + +- 演示 Kubernetes 文档如何使用 Markdown +- 提供一个 "冒烟测试" 文档,我们可以使用它来测试影响整个文档的 HTML、CSS 和模板更改。 + + + +## 标题级别 + + +上面的标题是 H2。页面标题呈现为 H1。以下部分显示 H3-H6。 + +### H3 + + +这是在 H3 部分。 + +#### H4 + + +这是在 H4 部分。 + + +##### H5 + + +这是在 H5 部分。 + +###### H6 + + +这是在 H6 部分。 + + +## 内联元素 + + +内联元素出现在段落、列表项、警告或其他块级元素的文本中。 + + + + + + +### 内联文本样式 + + + +- **粗体** +- _斜体_ +- ***加粗斜体*** +- ~~删除线~~ +- 下划线 +- _强调斜体_ +- **强调 bold** +- ***粗体斜体加下划线*** +- `等宽字体文本` +- **`等宽字体 bold`** + + + +## 列表 + + +Markdown 没有关于如何处理列表的严格规则。当我们从 Jekyll 搬到 Hugo 时,我们破坏了一些列表。要解决这些问题,请记住以下几点: + + + +- 确保缩进子列表项**4个空格**而不是您可能习惯的2个空格。与直觉相反,您需要将列表项中的块级内容缩进额外的4个空格。 +- 要结束列表并启动另一个列表,您需要在列表之间的新行上使用 HTML 注释块,并使用左侧边框刷新。 + 无论你在第一个列表和第二个列表之间放置多少空行,第一个列表都不会以其他方式结束。 + + + +### 项目符号列表 + + + +- 这是一个列表项 +* 这是同一列表中的另一个列表项 +- 你可以把 `-` 和 `*` 混合 + - 要生成一个子项目,缩进两个制表符(4个空格)。**这和 Jekyll 和 Kramdown 不一样。** + - 这是一个子项目。缩进另外两个制表符(另外4个空格)。 + - 另一个子项目。 + + + + +- 这是一个新列表。使用 Hugo,您需要使用 HTML 注释来分隔两个连续的列表。**HTML 注释需要在左边的空白处。** +- 项目符号列表可以包含段落或块元素。 + + + 将内容缩进到项目符号文本之外的一个制表符。**本段和代码块与上面 `Bullet` 中的第二个 `l` 对齐。** + + ```bash + ls -l + ``` + + - 以及一些块级内容之后的子列表 + + + +- 项目符号列表项可以包含编号列表。 + 1. 编号的子列表项目 1 + 2. 编号的子列表项目 2 + + + +### 编号列表 + + + +1. 这是一个列表项 +2. 这是同一列表中的另一个列表项。在 Markdown 中使用的数字不一定与最终输出中的数字相关。按照惯例,我们使它们保持同步。 +3. {{}} + 对于单位数字编号列表,在句点后使用两个空格可使内部块级内容沿制表符更好地排列。 + {{}} + + + + + +1. 这是一个新的列表。使用 Hugo,您需要使用 HTML 注释来分隔两个连续的列表。**HTML 注释需要在左边的空白处** +2. 编号列表可以包含段落或块元素。 + + 只需将内容缩进到 bullet 文本之外的一个制表符停止即可。**本段和代码块与上面 `Numbered` 中的 `m` 对齐。** + + + ```bash + $ ls -l + ``` + + + - 以及块级内容之后的子列表。这与上面的段落和代码块处于同一"级别",尽管缩进更多。 + + + + +### 标签列表 + + +标签列表可用于有条件地显示内容,例如,当必须记录多个需要不同指令或上下文的选项时。 + +{{< tabs name="tab_lists_example" >}} +{{% tab name="Choose one..." %}} + + +请选择一个选项。 + +{{% /tab %}} +{{% tab name="Formatting tab lists" %}} + + +标签也可以嵌套格式样式。 + + + +1. 有序 +2. (或无序) +3. 列表 + +```bash +$ echo 'Tab lists may contain code blocks!' +``` + +{{% /tab %}} +{{% tab name="Nested headers" %}} + + + +### 标签列表中的标题 + + +还可以包括嵌套标题标签。 + +{{< warning >}} + + +标签列表中的标题不会出现在目录中。 + +{{< /warning >}} + +{{% /tab %}} +{{< /tabs >}} + + + +### 检查列表 + + +检查列表在技术上是 bullet 列表,但项目符号被 CSS 抑制。 + + + +- [ ] 这是一个检查列表项目 +- [x] 这是一个选定的检查表项 + + + +## 代码块 + + +您可以用两种不同的方法创建代码块,方法是使用三个反勾号围绕代码块来以两种不同的方式创建代码块。 +**仅对代码块使用反向标记(代码栏)**,这允许您指定所附代码的语言,从而启用语法高亮显示。它也比缩进更容易预测。 + +{{< warning >}} + + +有一种情况需要对代码块使用缩进:当代码块的内容包含以 `-` 或 `*` 字符开头的行时。这是由于 [blackfriday 问题 #239](https://github.com/russross/blackfriday/issues/239). + +{{< /warning >}} + + + +``` +这是由反勾号创建的代码块 +``` + + +反勾号方法有一些优点。 + + +- 几乎每次都有效 +- 查看源代码,它更紧凑。 +- 它允许您指定代码块所在的语言,用于语法高亮显示。 +- 它有一个明确的结尾。有时候,缩进方法会中断一些间距很大的语言,比如 Python 或 YAML。 + + +要为代码块指定语言,请将其直接放在第一个代码块之后 +反勾号的分组: + +```bash +ls -l +``` + + +Kubernetes 文档代码块中使用的通用语言包括: + + +- `bash` / `shell` (两者都相同) +- `go` +- `json` +- `yaml` +- `xml` +- `none` (禁用块的语法突出显示) + + + +### 包含 Hugo 短代码的代码块 + + +要显示上面示例中的原始 Hugo 短代码并防止 Hugo 解释它们,请在 `<` 后面和 `>` 字符之前直接使用 C 风格的注释。 +下面的例子说明了这一点(查看此页面的 Markdown 源代码)。 + +```none +{{}} +``` + + + +## 链接 + + +要格式化链接,请将链接文本放在方括号中,然后将链接目标放在圆括号中。[链接到 Kubernetes.io](https://kubernetes.io/) 或者 +[Kubernetes.io 的相关链接](/) + + +您也可以使用 HTML,但不推荐使用它。 +链接到 Kubernetes.io + + + +## 图片 + + +要格式化图片,请使用与[链接](#links)类似的语法,但要添加一个前导 `!` 字符。 +方括号包含图片的 alt 文本。尽量使用 alt 文本,这样使用屏幕阅读器的人就可以从图片中获得一些好处。 + + + +![铅笔图标](/static/images/pencil.png) + + +要指定扩展属性,如宽度、标题、标题等,请使用图形短代码 +这是首选使用 HTML `` 标签。此外,如果您需要图片也是一个超链接,请使用 `link` 属性,而不是用 Markdown 链接语法包装整个图片,如下所示。 + + +{{< figure src="/static/images/pencil.png" title="铅笔图标”" caption="用于说明图片短代码的图片" width="200px" >}} + + +即使您选择不使用图形短代码,图片也可以是链接。这一次铅笔图标链接到 Kubernetes 网站。外部方括号将整个图像标记括起来,链接目标位于末尾的括号中。 + + +[![铅笔图标](/static/images/pencil.png)](https://kubernetes.io) + + +您还可以对图片使用 HTML,但不推荐使用 HTML。 + +pencil icon + + + +## 表 + + +简单表每行有一行,列由 `|` 字符分隔。标题由包含任何内容但至少包含三个 `-` 字符的单元格与主体分隔。 +为了便于维护,尽量保持所有的单元分隔符,即使你注意使用额外的空间。 + + + +| 标题单元 1 | 标题单元 2 | +|---------------|----- ---------| +| 主体单元 1 | 主体单元 2 | + + + +标题头是可选的。任何以 `|` 分隔的文本都将呈现为一个表。 + + +Markdown 在单元格中很难处理块级元素,例如列表项代码块或多个段落。对于复杂或非常宽的表,可以使用 HTML。 + + + + + + + + + + + + + + + + +
标题单元 1标题单元 2
主体单元 1主体单元 2
+ + + +## 侧边栏和警告 + + +侧边栏和警告提供了为文本添加视觉重要性的方法。谨慎使用它们。 + + + +### 侧边栏 + + +侧边栏在视觉上抵消了文本的影响,但是没有[警告](#admonitions)的视觉突出。 + + + + +> 这是一个侧边栏。 +> +> 您可以在侧栏中包含段落和块级元素。 +> +> 你甚至可以拥有代码块。 +> +> ```bash +> sudo dmesg +> ``` +> + + + + +### 警告 + + +警告(注释,警告等)使用 Hugo 短代码。 + + +{{< note >}} + + +笔记能抓住读者的注意力,而不带紧迫感。 + +警告中可以包含多个段落和块级元素。 + + +| Or | a | table | +{{< /note >}} + +{{< caution >}} + + +读者应该谨慎行事。 + +{{< /caution >}} + + +{{< warning >}} + + +警告指出如果被忽略可能会造成损害的事情。 + +{{< /warning >}} + + + + +## 包含 + +添加包含的短代码。 + +{{< note >}} +{{< include "federation-current-state.md" >}} +{{< /note >}} + + + +## Katacoda 嵌入式实时环境 + +{{< kat-button >}}