样式化

Mr.Hope ... 2022-6-4 大约 1 分钟

该插件可以对内联标记进行样式化,包括更改标签、添加属性和修改内容。

它可以很方便的为你创建行内 snippet。

# 配置







 






module.exports = {
  plugins: [
    [
      "md-enhance",
      {
        stylize: [
          // 选项
        ],
      },
    ],
  ],
};
1
2
3
4
5
6
7
8
9
10
11
12

# 使用

stylize 接收一个数组,其中每个元素接受 2 个选项:

  • matcher:应为 stringRegExp

  • replacer: 自定义匹配标记的函数

例如,你可以使用以下配置将 *Recommanded* 转换为徽章 <Badge type="tip">Recommanded</Badge>

module.exports = {
  plugins: [
    [
      "md-enhance",
      {
        stylize: [
          {
            match: "Recommanded",
            replacer: ({ tag, attrs }) => {
              if (tag === "em")
                return {
                  tag: "Badge",
                  attrs: { type: "tip" },
                  content: "Recommanded",
                };
            },
          },
        ],
      },
    ],
  ],
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

另一个例子是你想要将所有的“不或者没”开头的强调词设置为红色,这样 设置它*没有*任何效果,请*不要*这样使用。变成:“设置它没有任何效果,请不要这样使用。"

module.exports = {
  plugins: [
    [
      "md-enhance",
      {
        stylize: [
          {
            match: /n't$/,
            replacer: ({ tag, attrs, content }) => {
              if (tag === "em")
                return {
                  tag: "span",
                  attrs: { style: "color: red" },
                  content,
                };
            },
          },
        ],
      },
    ],
  ],
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

如果你想跳过某些页面中的某些单词,你可以在页面 frontmatter 中设置 noStylize 数组,并放置你不想风格化的内容。

性能

为避免性能影响,除非你需要,否则应尽量避免使用 RegExp 以获得更好的性能。

并且请尝试使用成本较低的 RegExp 创建片段,例如:以 ^ 开头或以 $ 结尾 RegExp 。

例如,如果你只想匹配 "SHOULD"、"MUST" 和 "MAY",你应该写 /^(?:SHOULD|M(?:UST|AY))$/u 而不是 /SHOULD|MUST|MAY/u。第一个将和 1000 个字符的“A loo...oong content”只匹配 2 次,但第二个 RegExp 会匹配近 3000 次。

上次编辑于: 2022年6月4日 13:16
贡献者: Mr.Hope