内容注释
约 731 字大约 2 分钟
2025-02-23
描述
Annotation(注释) 是 Markdown 中的一种特殊的语法,用于在文档中添加额外的信息、说明或者提示。
注释不会直接显示在文档中,需要用户手动点击才会显示。
配置
该功能默认不启用,你需要在 theme
配置中启用。
.vuepress/config.ts
export default defineUserConfig({
theme: plumeTheme({
plugins: {
markdownPower: {
annotation: true,
},
}
})
})
语法
Annotation(注释) 语法有两个部分组成:
- 行内注释: 在行内通过
[+label]
语法插入注释。 - 定义注释: 在文档单独一行中使用
[+label]: 内容
语法定义注释。
符号 +
是必须的
- 行内注释语法由
[+
+label
+]
组成。 - 定义注释语法由
[+
+label
+]:
+内容
组成。
输入:
站点由 VuePress [+vuepress] 驱动。
[+vuepress]: VuePress 是一个 [静态站点生成器](https://en.wikipedia.org/wiki/Static_site_generator) (SSG) 。 专为构建快速、以内容为中心的站点而设计。
输出:
站点由 VuePress 驱动。VuePress 是一个 静态站点生成器 (SSG) 。 专为构建快速、以内容为中心的站点而设计。
还可以为 label
定义多个注释,多个定义将会以列表的形式渲染。
输入:
中国古代 **四大名著** [+名著] 家喻户晓。
[+名著]: **《三国演义》:** 以三国时期的历史为背景,描写了魏、蜀、吴三国之间的政治、军事斗争,塑造了诸葛亮、曹操、关羽、刘备等众多历史人物形象。
[+名著]: **《西游记》:** 讲述了唐僧师徒四人(孙悟空、猪八戒、沙僧、白龙马)西天取经的故事,充满了神话色彩和奇幻冒险。
[+名著]: **《红楼梦》:** 以贾、史、王、薛四大家族的兴衰为背景,描写了贾宝玉、林黛玉、薛宝钗等人的爱情悲剧,展现了封建社会的腐朽与没落。
[+名著]: **《水浒传》:** 描写了北宋末年以宋江为首的108位好汉在梁山泊聚义,反抗朝廷的故事,展现了官逼民反的社会现实。
输出:
中国古代 四大名著 家喻户晓。《三国演义》: 以三国时期的历史为背景,描写了魏、蜀、吴三国之间的政治、军事斗争,塑造了诸葛亮、曹操、关羽、刘备等众多历史人物形象。《西游记》: 讲述了唐僧师徒四人(孙悟空、猪八戒、沙僧、白龙马)西天取经的故事,充满了神话色彩和奇幻冒险。《红楼梦》: 以贾、史、王、薛四大家族的兴衰为背景,描写了贾宝玉、林黛玉、薛宝钗等人的爱情悲剧,展现了封建社会的腐朽与没落。《水浒传》: 描写了北宋末年以宋江为首的108位好汉在梁山泊聚义,反抗朝廷的故事,展现了官逼民反的社会现实。