https://github.com/pcrab/hexo-highlight-shiki

https://github.com/pcrab/hexo-highlight-shiki

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/pcrab/hexo-highlight-shiki
• Owner: Pcrab
• License: mit
• Created: 2023-03-21T03:35:30.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T14:55:30.000Z (9 months ago)
• Last Synced: 2024-05-31T15:29:47.575Z (7 months ago)
• Language: JavaScript
• Size: 41 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hexo Highlight Shiki

Use [shiki](https://github.com/shikijs/shiki) as code block highlighter instead of builtin highlight.js or prism.js.

Currently only works in hexo version >= `7.0.0`, which has a better highlight extend api.

Otherwise please use official plugin [hexo-shiki-twoslash](https://github.com/shikijs/twoslash/tree/main/packages/hexo-shiki-twoslash) instead.

## Installation

1. Install thiis package.

   ```sh

   pnpm add hexo-highlight-shiki

   ```

2. Setup config

   ```yaml

   syntax_highlighter: "shiki"

   ```

3. Configure theme (default to `github-light`)

   ```yaml

   shiki:

     theme: "github-light"

   ```

4. Configure renderer if using [djot](htts://github.com/Pcrab/hexo-renderer-djot)

   ```yaml

   shiki:

     renderer: "djot"

   ```