HPCesia/hexo-highlighter-shiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: Update READMEs to specify Hexo dependency

Browse Source 
- Added link to Hexo repository
- Clarified comment on `original_lang_name` in English version
This commit is contained in:
HPCesia 2024-10-29 14:14:06 +08:00
parent c111ee0243
commit 68115abd81
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -5,7 +5,7 @@ English丨[简体中文](README_zh-CN.md)
A hexo plugin to use [Shiki](https://github.com/shikijs/shiki) as code block highlighter. A hexo plugin to use [Shiki](https://github.com/shikijs/shiki) as code block highlighter.
Hexo v7.0.0+ is required. [Hexo](https://github.com/hexojs/hexo) v7.0.0+ is required.
## Features ## Features
- Use [Shiki](https://github.com/shikijs/shiki) to render code blocks, and the format is similar to Hexo's default code highlighting (so you don't need to make significant changes to the theme you are currently using). - Use [Shiki](https://github.com/shikijs/shiki) to render code blocks, and the format is similar to Hexo's default code highlighting (so you don't need to make significant changes to the theme you are currently using).
@ -90,7 +90,8 @@ See [Dual Themes](https://shiki.style/guide/dual-themes) for how to switch betwe
You can also specify some languages individually in `original_lang_name` to not convert or only convert them: You can also specify some languages individually in `original_lang_name` to not convert or only convert them:
```yaml ```yaml
original_lang_name: original_lang_name:
# Set to true to exclude the languages listed in `langs`, otherwise only convert the languages in `langs`. # Set to true to exclude the languages listed in `langs`,
# otherwise only convert the languages in `langs`.
exclude: true exclude: true
# Must be an array # Must be an array
langs: langs:

2
README_zh-CN.md
View File

@ -5,7 +5,7 @@
一个使用 [Shiki](https://github.com/shikijs/shiki) 作为代码块高亮器的 Hexo 插件。 一个使用 [Shiki](https://github.com/shikijs/shiki) 作为代码块高亮器的 Hexo 插件。
需要 Hexo v7.0.0+。 需要 [Hexo](https://github.com/hexojs/hexo) v7.0.0+。
## 功能 ## 功能
- 使用 [Shiki](https://github.com/shikijs/shiki) 渲染代码块，且与 Hexo 默认的代码高亮渲染的格式相似（因此你不需要对你现在使用的主题做很大的修改）。 - 使用 [Shiki](https://github.com/shikijs/shiki) 渲染代码块，且与 Hexo 默认的代码高亮渲染的格式相似（因此你不需要对你现在使用的主题做很大的修改）。