HPCesia c03510a8a7 feat: support custom theme.

feat: support to set default theme color and css variable prefix options.

2024-10-21 16:40:34 +08:00

2.9 KiB

Raw Blame History

Hexo-Highlight-Shiki

English丨简体中文

一个使用 Shiki 作为代码块高亮器的 Hexo 插件。

需要 Hexo v7.0.0+。

功能

使用 Shiki 渲染代码块，类似于 Hexo 默认的高亮器。
支持双主题或更多主题。
支持自定义语言。

安装与配置

首先，安装本插件：

npm install hexo-highlighter-shiki --save

然后在 config.yml 中切换代码高亮引擎：

syntax_highlighter: shiki

最后配置 shiki：

shiki:
  theme: one-dark-pro

配置项

完整配置如下：

shiki:
  theme: "one-dark-pro" # 主题，请参阅 https://shiki.style/themes 以获取支持的主题列表。
  line_number: false
  strip_indent: true
  tab_replace: "  "
  pre_style: true # 保留 <pre> 标签的样式，即主题的 `background-color`。
  default_color: light # 仅在同时使用多个主题时生效。默认值：light
  css_variable_prefix: --shiki- # 仅在同时使用多个主题时生效。默认值：--shiki-
  additional:
    themes: # 要添加的主题的 TextMate 主题 json 列表。
    langs: # 要添加的语言的 TextMate 语法 json 列表。
      - path/to/lang_grammar.json
    lang_alias: # 语言的别名列表。
      your_alias1: lang_name1
      your_alias2: lang_name2

额外地，你可以在 theme 选项中指定多个主题：

shiki:
  theme:
    light: one-light
    dark: one-dark-pro
    # ...

在 Dual Themes 中查看如何切换多个主题。

Bugs

mathjax

如果你正在使用 hexo-filter-mathjax 或其他任意在本地使用 mathjax 渲染数学公式的插件，在渲染包含代码块且开启 mathjax 渲染的文章时可能会出现 Error: Can't find handler for document。这是 mathjax 的问题，mathjax 的 LiteDOM adaptor 无法解析复杂的 HTML 片段。

解决方法

以 hexo-filter-mathjax 插件为例，修改源代码中的这一行:

- data.content = mathjax(data.content);
+ data.content = data.content.replace(/<span\s+class="math\s+[^"]*">\\[\(\[].*?\\[\)\]]<\/span>/gs, mathjax);

这可以避免对那些复杂的 HTML 片段进行渲染导致的 Can't find handler for document 错误。

感谢

本插件基于

进行开发。

2.9 KiB Raw Blame History Unescape Escape