80 lines
1.7 KiB
Markdown
80 lines
1.7 KiB
Markdown
# `@vuepress-plume/plugin-shikiji`
|
|
|
|
使用 [`shiki`](https://shiki.style/) 为 Markdown 代码块启用代码高亮。
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install @vuepress-plume/plugin-shikiji
|
|
# or
|
|
pnpm add @vuepress-plume/plugin-shikiji
|
|
# or
|
|
yarn add @vuepress-plume/plugin-shikiji
|
|
```
|
|
|
|
## Usage
|
|
|
|
``` js
|
|
// .vuepress/config.[jt]s
|
|
import { shikijiPlugin } from '@vuepress-plume/plugin-shikiji'
|
|
|
|
export default {
|
|
// ...
|
|
plugins: [
|
|
shikijiPlugin()
|
|
]
|
|
// ...
|
|
}
|
|
```
|
|
|
|
## Options
|
|
|
|
```ts
|
|
interface ShikijiOptions {
|
|
/**
|
|
* Custom theme for syntax highlighting.
|
|
*
|
|
* You can also pass an object with `light` and `dark` themes to support dual themes.
|
|
*
|
|
* @example { theme: 'github-dark' }
|
|
* @example { theme: { light: 'github-light', dark: 'github-dark' } }
|
|
*
|
|
* You can use an existing theme.
|
|
* @see https://shiki.style/themes
|
|
* Or add your own theme.
|
|
* @see https://shiki.style/guide/load-theme
|
|
*/
|
|
theme?: ThemeOptions
|
|
/**
|
|
* Languages for syntax highlighting.
|
|
* @see https://shiki.style/languages
|
|
*/
|
|
languages?: LanguageInput[]
|
|
/**
|
|
* Custom language aliases.
|
|
*
|
|
* @example { 'my-lang': 'js' }
|
|
* @see https://shiki.style/guide/load-lang#custom-language-aliases
|
|
*/
|
|
languageAlias?: Record<string, string>
|
|
/**
|
|
* Setup Shikiji instance
|
|
*/
|
|
shikiSetup?: (shikiji: Highlighter) => void | Promise<void>
|
|
/**
|
|
* Fallback language when the specified language is not available.
|
|
*/
|
|
defaultHighlightLang?: string
|
|
/**
|
|
* Transformers applied to code blocks
|
|
* @see https://shiki.style/guide/transformers
|
|
*/
|
|
codeTransformers?: ShikiTransformer[]
|
|
/**
|
|
* Enable transformerRenderWhitespace
|
|
* @default false
|
|
*/
|
|
whitespace?: boolean
|
|
}
|
|
```
|