Markdown 指南
本主题提供额外的 Markdown 使用指南,以及关于 做出更大贡献 主题中已涵盖的 Markdown 编辑功能的更多详细信息。
内联样式
双波浪号 (~) 可用于显示带有删除线的文本。
例如,此 Markdown 将输出以下文本
~~This text will have a strikethrough style~~
此文本将带有删除线
链接和引用
有多种类型的链接和引用可以添加到使用 Hugo 构建的 Markdown 文件中。每种都有等效的内联 Markdown。所有链接和引用都呈现为绿色文本。
外部链接
这种类型的链接用于引用文档站点之外的内容,通常是另一个网站。
内联 Markdown | 示例 |
---|---|
[显示文本](<site-address>) | [Cumulus 文档](http://docs.cumulusnetworks.com) |
请勿使用传统的 markdown 链接来链接文档中的页面。使用自定义的 link
短代码来链接内部文档页面。
页内锚点
这种类型的链接用于引用同一文件中另一节的内容。
内联 Markdown | 示例 |
---|---|
[显示文本](#<section-title>/) | [Hugo 短代码](#hugo-shortcodes) |
<section-title> 必须全部小写,并且必须使用破折号替换任何空格,无论实际标题的格式如何。
图像引用
通常,Cumulus 使用 img 和 figure 短代码来引用静态图像;但是,您也可以使用内联 Markdown。

请注意,参考文本不会显示。
例如,此 Markdown 渲染以下图像
![Trace Request Small]
表格
在 Markdown 中创建表格非常容易。使用三个或更多连字符 (—) 来创建每个列标题,并使用竖线 (|) 分隔每列。虽然是可选的,但 Cumulus 也在表格行的两端使用竖线。
例如,此 Markdown 渲染以下表格

标题 | 描述 |
---|---|
文本 | 文本 |
文本 | 文本 |
对齐内容
冒号可用于对齐列内容。
例如,此 Markdown 渲染以下表格

表格 | 是 | 有趣 |
---|---|---|
列 1 | 左对齐 | $1 |
列 2 | 居中对齐 | $12 |
列 3 | 右对齐 | $1600 |
使用内联样式
如果需要,您也可以使用内联 Markdown 来格式化文本。
例如,此 Markdown 渲染以下表格

使用 | 内联 | Markdown |
---|---|---|
斜体 | 命令 | 粗体 |