Skip to content

Commit 7296742

Browse files
committed
chore: 添加变量声明组件语法说明
1 parent 96e9819 commit 7296742

File tree

2 files changed

+62
-42
lines changed

2 files changed

+62
-42
lines changed

.vitepress/theme/markdown/variableInject.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ function variableInject(md: MarkdownIt): void {
1717
if (silent) return true
1818

1919
// Extract key and value
20-
const key = match[1]
20+
const key = (match[1] ?? '').trim()
2121
const value = match[2]
2222

2323
variables[key] = value
@@ -40,7 +40,7 @@ function variableInject(md: MarkdownIt): void {
4040
if (silent) return true
4141

4242
// Extract key and get value
43-
const key = match[1] ?? ''
43+
const key = (match[1] ?? '').trim()
4444
const value = variables[key] ?? ''
4545

4646
// Create content token

src/zh/md-enhance-guide.md

Lines changed: 60 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,64 @@ theme: medium
189189
```
190190
````
191191

192+
## 变量声明 {#variable}
193+
194+
用于声明并使用可重复使用的 Markdown 部分
195+
196+
声明时使用以下语法,此语句不会产生任何内容
197+
198+
- 示例中 `KEY` 为变量名,
199+
- 变量名前后可加空格
200+
- 变量名仅可包含字母数字与下划线
201+
202+
```md
203+
{define:KEY}_被声明的内容_{/define}
204+
```
205+
206+
{define:KEY}_被声明的内容_{/define}
207+
208+
使用变量声明时,使用以下语法
209+
210+
```md
211+
{{ KEY }}
212+
```
213+
214+
{{ KEY }}
215+
216+
## Spoiler 文本遮罩 {#spolier}
217+
218+
用于隐藏内容的插件
219+
220+
使用 !! !! 进行标记。
221+
222+
输入!!xxx!!显示彩蛋
223+
224+
```md
225+
输入!!xxx!!显示彩蛋
226+
```
227+
228+
## Custom Color 自定义文字颜色 {#custom-color}
229+
230+
用于设置文字颜色的插件
231+
232+
```md
233+
{color:#FF5733}红橙色文字{/color} 普通文字 {color:#33FF57}绿色文字{/color}
234+
235+
{color: red}红色文字{/color}
236+
237+
{color: var(--vp-c-purple-3)}_使用CSS Var的紫色文字_{/color}
238+
239+
{color: rgba(44,195,184,1)}**使用RGBA的青色文字**{/color}
240+
```
241+
242+
{color:#FF5733}红橙色文字{/color} 普通文字 {color:#33FF57}绿色文字{/color}
243+
244+
{color: red}红色文字{/color}
245+
246+
{color: var(--vp-c-purple-3)}_使用CSS Var的紫色文字_{/color}
247+
248+
{color: rgba(44,195,184,1)}**使用RGBA的青色文字**{/color}
249+
192250
## Frontmatter Config {#frontmatter}
193251

194252
### footer {#fm-footer}
@@ -211,7 +269,7 @@ footer: false #隐藏该页面的页脚
211269

212270
是否显示页面的侧边栏
213271

214-
> 仅会在 `Layout: doc` 时自动启用
272+
> 仅会在 `layout: doc` 时自动启用
215273
216274
```yml
217275
---
@@ -264,48 +322,10 @@ bannerExpiryDate: 2024-2-1
264322

265323
是否使用 docHeader 展示标题
266324

267-
> 仅会在 `Layout: doc` 时自动启用
325+
> 仅会在 `layout: doc` 时自动启用
268326
269327
```yml
270328
---
271329
docHeader: false #隐藏该页面的 docHeader
272330
---
273331
```
274-
275-
### Spoiler {#spolier}
276-
277-
用于隐藏内容的插件
278-
279-
使用 !! !! 进行标记。
280-
281-
#### Example {#spolier-example}
282-
283-
输入!!xxx!!显示彩蛋
284-
285-
```md
286-
输入!!xxx!!显示彩蛋
287-
```
288-
289-
### Custom Color 自定义文字颜色 {#custom-color}
290-
291-
用于设置文字颜色的插件
292-
293-
#### Example {#custom-color-example}
294-
295-
```md
296-
{color:#FF5733}红橙色文字{/color} 普通文字 {color:#33FF57}绿色文字{/color}
297-
298-
{color: red}红色文字{/color}
299-
300-
{color: var(--vp-c-purple-3)}_使用CSS Var的紫色文字_{/color}
301-
302-
{color: rgba(44,195,184,1)}**使用RGBA的青色文字**{/color}
303-
```
304-
305-
{color:#FF5733}红橙色文字{/color} 普通文字 {color:#33FF57}绿色文字{/color}
306-
307-
{color: red}红色文字{/color}
308-
309-
{color: var(--vp-c-purple-3)}_使用CSS Var的紫色文字_{/color}
310-
311-
{color: rgba(44,195,184,1)}**使用RGBA的青色文字**{/color}

0 commit comments

Comments
 (0)