该微件用于生成 Markdown 源码和实际渲染的显示效果对照的表格。

短代码

参数

名称	类型	必要	值	描述
（Inner）		是
title	字符串	否		表格标题
type	字符串	否	row（默认）、col	上下对照 或 左右对照 显示
inline	布尔	否	true、false（默认）	使用 code 或 pre 展示 Markdown 源码
icon	布尔	否	true（默认）、false	是否显示 Markdown 图标 ()
extended	布尔	否	true、false	是否使渲染效果栏占满横向空间 当 type 为 row 时默认为 true 当 type 为 col 时默认为 false
class	字符串	否		额外的 CSS 类
style	字符串	否		额外的 CSS 样式

用法

1. 将需要对照展示的 Markdown 源码放在闭合的此短代码中间

   Markdown	渲染效果
   {{< example >}} **Bold** *Italic* ~~Strikethrough~~ {{< /example >}}	Markdown **Bold** *Italic* ~~Strikethrough~~ 渲染效果 Bold Italic Strikethrough

   对于需要展示的内容，若包含短代码，需要使用 /* 和 */ 禁止短代码的直接渲染

   Markdown	渲染效果
   {{< example >}} *Markdown* 图标：{{</* icon "xi-markdown" */>}} {{< /example >}}	Markdown *Markdown* 图标：{{< icon "xi-markdown" >}} 渲染效果 Markdown 图标：

2. 通过此短代码的自我嵌套，可在一个表格中对照展示多段 Markdown 源码

   Markdown	渲染效果
   {{< example type="col" inline=true >}} {{< example >}} **Bold** {{< /example >}} {{< example >}} *Italic* {{< /example >}} {{< example >}} ~~Strikethrough~~ {{< /example >}} {{< /example >}}	Markdown 渲染效果 **Bold** Bold *Italic* Italic ~~Strikethrough~~ Strikethrough

示例

下面展示基本参数的示例，更多具体示例可通过查看使用了此短代码的页码的源码。

• 参数 title

  Markdown	渲染效果
  {{< example title="标题" >}} *Italic* {{< /example >}}	标题 Markdown *Italic* 渲染效果 Italic

• 参数 type

  Markdown	渲染效果
  {{< example type="row" >}} *Italic* {{< /example >}}	Markdown *Italic* 渲染效果 Italic
  {{< example type="col" >}} *Italic* {{< /example >}}	Markdown 渲染效果 *Italic* Italic

• 参数 inline

  Markdown	渲染效果
  {{< example inline=true >}} *Italic* {{< /example >}}	Markdown *Italic* 渲染效果 Italic
  {{< example inline=false >}} *Italic* {{< /example >}}	Markdown *Italic* 渲染效果 Italic

• 参数 icon

  Markdown	渲染效果
  {{< example icon=true >}} *Italic* {{< /example >}}	Markdown *Italic* 渲染效果 Italic
  {{< example icon=false >}} *Italic* {{< /example >}}	Markdown *Italic* 渲染效果 Italic

• 参数 extended

  Markdown	{{< example type="row" extended=true >}} *Italic* {{< /example >}}
  渲染效果	Markdown *Italic* 渲染效果 Italic

  Markdown	{{< example type="row" extended=false >}} *Italic* {{< /example >}}
  渲染效果	Markdown *Italic* 渲染效果 Italic