docs(doc-entries): Show examples as code blocks
Directive examples sat bare in the doc bodies, so rendering them as markdown executed the directives: live components, missing-file fetches, and style side effects on the dialog. Wrap each example in a markdown fence, matching the convention already used by md-table.
This commit is contained in:
@@ -9,14 +9,16 @@ title: 背景组件
|
|||||||
**语法:** `:md-bg[颜色或图片路径]{选项}`
|
**语法:** `:md-bg[颜色或图片路径]{选项}`
|
||||||
|
|
||||||
**设置背景图:**
|
**设置背景图:**
|
||||||
|
```markdown
|
||||||
:md-bg[./images/dungeon-bg.jpg]{fit="cover"}
|
:md-bg[./images/dungeon-bg.jpg]{fit="cover"}
|
||||||
|
```
|
||||||
|
|
||||||
**设置纯色背景:**
|
**设置纯色背景:**
|
||||||
|
```markdown
|
||||||
:md-bg[#2a1a3a]
|
:md-bg[#2a1a3a]
|
||||||
|
|
||||||
:md-bg[rgb(200,50,50)]
|
:md-bg[rgb(200,50,50)]
|
||||||
|
|
||||||
:md-bg[#ff00dd]
|
:md-bg[#ff00dd]
|
||||||
|
```
|
||||||
|
|
||||||
支持图片路径或任意 CSS 颜色值(hex、rgb、颜色名等)。
|
支持图片路径或任意 CSS 颜色值(hex、rgb、颜色名等)。
|
||||||
|
|
||||||
|
|||||||
@@ -9,16 +9,24 @@ title: 边框组件
|
|||||||
**语法:** `:md-border[颜色或图片路径]{方位类 样式类 选项}`
|
**语法:** `:md-border[颜色或图片路径]{方位类 样式类 选项}`
|
||||||
|
|
||||||
**纯色左边框:**
|
**纯色左边框:**
|
||||||
|
```markdown
|
||||||
:md-border[#3b82f6]{.l}
|
:md-border[#3b82f6]{.l}
|
||||||
|
```
|
||||||
|
|
||||||
**虚线上下边框:**
|
**虚线上下边框:**
|
||||||
|
```markdown
|
||||||
:md-border[red]{.t .b .dashed width=".2mm"}
|
:md-border[red]{.t .b .dashed width=".2mm"}
|
||||||
|
```
|
||||||
|
|
||||||
**图片边框:**
|
**图片边框:**
|
||||||
|
```markdown
|
||||||
:md-border[./images/frame.png]{.all .round}
|
:md-border[./images/frame.png]{.all .round}
|
||||||
|
```
|
||||||
|
|
||||||
**左右图片竖条:**
|
**左右图片竖条:**
|
||||||
|
```markdown
|
||||||
:md-border[./images/ornament.png]{.l .r .repeat}
|
:md-border[./images/ornament.png]{.l .r .repeat}
|
||||||
|
```
|
||||||
|
|
||||||
## 方位类
|
## 方位类
|
||||||
|
|
||||||
|
|||||||
@@ -9,10 +9,14 @@ title: 卡牌组件
|
|||||||
**语法:** `:md-deck[./cards.csv]{选项}` 或 yaml 代码块
|
**语法:** `:md-deck[./cards.csv]{选项}` 或 yaml 代码块
|
||||||
|
|
||||||
**基础卡牌:**
|
**基础卡牌:**
|
||||||
|
```markdown
|
||||||
:md-deck[./spells.csv]{grid="3x3"}
|
:md-deck[./spells.csv]{grid="3x3"}
|
||||||
|
```
|
||||||
|
|
||||||
**多层卡牌:**
|
**多层卡牌:**
|
||||||
|
```markdown
|
||||||
:md-deck[./cards.csv]{grid="5x8" layers="title:1,1-5,1f8 body:1,5-8,8f3"}
|
:md-deck[./cards.csv]{grid="5x8" layers="title:1,1-5,1f8 body:1,5-8,8f3"}
|
||||||
|
```
|
||||||
|
|
||||||
CSV 包含数据字段列,通过图层定义控制各字段的位置、大小和对齐。
|
CSV 包含数据字段列,通过图层定义控制各字段的位置、大小和对齐。
|
||||||
|
|
||||||
|
|||||||
@@ -8,11 +8,20 @@ title: 骰子组件
|
|||||||
|
|
||||||
**语法:** `:md-dice[公式]{key="标识"}`
|
**语法:** `:md-dice[公式]{key="标识"}`
|
||||||
|
|
||||||
**攻击检定:** :md-dice[1d20+5]{key="attack"}
|
**攻击检定:**
|
||||||
|
```markdown
|
||||||
|
:md-dice[1d20+5]{key="attack"}
|
||||||
|
```
|
||||||
|
|
||||||
**伤害掷骰:** :md-dice[2d6+3]{key="damage"}
|
**伤害掷骰:**
|
||||||
|
```markdown
|
||||||
|
:md-dice[2d6+3]{key="damage"}
|
||||||
|
```
|
||||||
|
|
||||||
**优势检定:** :md-dice[2d20k1+5]{key="advantage"}
|
**优势检定:**
|
||||||
|
```markdown
|
||||||
|
:md-dice[2d20k1+5]{key="advantage"}
|
||||||
|
```
|
||||||
|
|
||||||
点击 🎲 图标执行投掷,显示结果;点击文字重置为原始公式。
|
点击 🎲 图标执行投掷,显示结果;点击文字重置为原始公式。
|
||||||
|
|
||||||
|
|||||||
@@ -9,10 +9,14 @@ title: 嵌入组件
|
|||||||
**语法:** `:md-embed[路径#章节]{选项}`
|
**语法:** `:md-embed[路径#章节]{选项}`
|
||||||
|
|
||||||
**嵌入完整文档:**
|
**嵌入完整文档:**
|
||||||
|
```markdown
|
||||||
:md-embed[./rules.md]
|
:md-embed[./rules.md]
|
||||||
|
```
|
||||||
|
|
||||||
**嵌入指定章节:**
|
**嵌入指定章节:**
|
||||||
|
```markdown
|
||||||
:md-embed[./rules.md#combat]
|
:md-embed[./rules.md#combat]
|
||||||
|
```
|
||||||
|
|
||||||
嵌入后内容直接在当前位置显示,包括其中的表格、骰子等组件也会正常渲染。
|
嵌入后内容直接在当前位置显示,包括其中的表格、骰子等组件也会正常渲染。
|
||||||
|
|
||||||
|
|||||||
@@ -9,18 +9,25 @@ title: 字体组件
|
|||||||
**语法:** `:md-font[字体名]{选项}`
|
**语法:** `:md-font[字体名]{选项}`
|
||||||
|
|
||||||
**Google 字体:**
|
**Google 字体:**
|
||||||
|
```markdown
|
||||||
:md-font[Noto Sans SC]{source="google"}
|
:md-font[Noto Sans SC]{source="google"}
|
||||||
|
```
|
||||||
|
|
||||||
**Emfont 字体:**
|
**Emfont 字体:**
|
||||||
|
```markdown
|
||||||
:md-font[Source Han Serif]{source="emfont" weight="700"}
|
:md-font[Source Han Serif]{source="emfont" weight="700"}
|
||||||
|
```
|
||||||
|
|
||||||
**本地字体(默认):**
|
**本地字体(默认):**
|
||||||
|
```markdown
|
||||||
:md-font[STSong]
|
:md-font[STSong]
|
||||||
|
```
|
||||||
|
|
||||||
**设置文字颜色:**
|
**设置文字颜色:**
|
||||||
|
```markdown
|
||||||
:md-font[Noto Sans SC]{source="google" color="#1a1a2e"}
|
:md-font[Noto Sans SC]{source="google" color="#1a1a2e"}
|
||||||
|
|
||||||
:md-font[Noto Sans SC]{source="google" weight="700" color="crimson"}
|
:md-font[Noto Sans SC]{source="google" weight="700" color="crimson"}
|
||||||
|
```
|
||||||
|
|
||||||
字体和颜色将应用到整个文档卡片。
|
字体和颜色将应用到整个文档卡片。
|
||||||
|
|
||||||
|
|||||||
@@ -9,10 +9,14 @@ title: 链接组件
|
|||||||
**语法:** `:md-link[路径#章节]`
|
**语法:** `:md-link[路径#章节]`
|
||||||
|
|
||||||
**展开完整文档:**
|
**展开完整文档:**
|
||||||
|
```markdown
|
||||||
:md-link[./rules.md]
|
:md-link[./rules.md]
|
||||||
|
```
|
||||||
|
|
||||||
**展开特定章节:**
|
**展开特定章节:**
|
||||||
|
```markdown
|
||||||
:md-link[./rules.md#combat]
|
:md-link[./rules.md#combat]
|
||||||
|
```
|
||||||
|
|
||||||
点击链接即可内联展开目标内容,再次点击折叠。
|
点击链接即可内联展开目标内容,再次点击折叠。
|
||||||
|
|
||||||
|
|||||||
@@ -9,13 +9,19 @@ title: 标记组件
|
|||||||
**语法:** `:md-pins[图片路径]{选项}`
|
**语法:** `:md-pins[图片路径]{选项}`
|
||||||
|
|
||||||
**固定标记(只读):**
|
**固定标记(只读):**
|
||||||
|
```markdown
|
||||||
:md-pins[./images/battle-map.png]{pins="A:25,50 B:75,30" fixed}
|
:md-pins[./images/battle-map.png]{pins="A:25,50 B:75,30" fixed}
|
||||||
|
```
|
||||||
|
|
||||||
**可编辑标记:**
|
**可编辑标记:**
|
||||||
|
```markdown
|
||||||
:md-pins[./images/blank-map.png]
|
:md-pins[./images/blank-map.png]
|
||||||
|
```
|
||||||
|
|
||||||
**数字标签:**
|
**数字标签:**
|
||||||
|
```markdown
|
||||||
:md-pins[./images/dungeon.png]{labelStart="1"}
|
:md-pins[./images/dungeon.png]{labelStart="1"}
|
||||||
|
```
|
||||||
|
|
||||||
非 `fixed` 模式下点击图片添加标记,点击标记删除。
|
非 `fixed` 模式下点击图片添加标记,点击标记删除。
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,9 @@ title: 叙事线组件
|
|||||||
**语法:** `:md-yarn-spinner[./story.yarn]{选项}`
|
**语法:** `:md-yarn-spinner[./story.yarn]{选项}`
|
||||||
|
|
||||||
**加载叙事文件:**
|
**加载叙事文件:**
|
||||||
|
```markdown
|
||||||
:md-yarn-spinner[./story.yarn]
|
:md-yarn-spinner[./story.yarn]
|
||||||
|
```
|
||||||
|
|
||||||
Yarn Spinner 是用于游戏对话系统的格式,支持选项、条件分支和变量。
|
Yarn Spinner 是用于游戏对话系统的格式,支持选项、条件分支和变量。
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user