# @aparte/plugin-shiki 中文文档

规范地址：https://npmcn.com/package/%40aparte/plugin-shiki/

版本：0\.32\.1
npm 元数据更新时间：2026-11-02T11:24:54.215Z
中文译文更新时间：2026-11-06T08:57:59.411Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aparte/plugin-shiki
原文对照：https://npmcn.com/package/%40aparte/plugin-shiki/?lang=original
项目主页：https://apartejs.dev/guides/markdown/
源码仓库：https://github.com/apartejs/aparte

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：30.3 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- peer 依赖：shiki ^4\.0\.0，@aparte/core \>=0\.32\.1 \<1\.0\.0
- 首次发布：2026-07-23T17:54:03.782Z
- 最新版本发布：2026-11-02T11:24:53.829Z
- 近 30 天下载量：5343（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：65（近 12 个月 65 个）

## 中文简介

通过 shiki 对分的语法加亮 – 将其注册为发亮提供者( single lazily-created signer).

## 安装

```sh
npm install @aparte/plugin-shiki
```

也可以使用：`pnpm add @aparte/plugin-shiki`、`yarn add @aparte/plugin-shiki`、`bun add @aparte/plugin-shiki`

## README

# @aparte/ plugin-shiki (英语)

语法突出显示 [独立](https://github.com/apartejs/aparte) 通过 [志纪](https://shiki.style/)。 。 。 . 将 shiki 注册为突出显示提供者, 并辅以 **单个懒散创建的突出显示器** - 语法 和按需装入的主题负载并被缓存,所以你永远不会重新初始化每个代码块.

```bash
npm install @aparte/plugin-shiki @aparte/core shiki
```

```ts
import { setupShikiProvider } from '@aparte/plugin-shiki';

await setupShikiProvider({ theme: 'github-dark' });
```

`@aparte/core` 财务报告和审定财务报表 `shiki` 为: **同行依赖关系**。 。 。 . `setupShikiProvider` 自动同步 `await` 一次 一次 在渲染突出显示消息前启动 .

## 两个切入点,因为大小是一个选择

**正在装入** 无论是懒惰还是懒惰:语言第一次出现时会获取语法,而且未知 语言降解为纯文本,而不是扔出.

**航运** 没有。 上面的导入拉入 `shiki`,其捆绑地图 _每个_ 已知语言a 动态导入, 因此您的捆绑器每个语法会输出一个文件 其他情况:

| 您导入 | 文件已发布 | 重量 |
| --- | --- | --- |
| `@aparte/plugin-shiki` | 302 (简体中文) | 11 个 MB |
| `@aparte/plugin-shiki/core` (3个语法) | 1个 | 560千贝 |

列出各种语言的选项不会改变这一点——静态导入是静态导入(测量: 仍为302文件). 所以,如果你运送的东西很重要, 建立亮点自己 并把它交给:

这些精细的入口 **单独的软件包** ——同时增加 `shiki`数字 :

```bash
npm install @shikijs/langs @shikijs/themes
```

```ts
import { createHighlighterCore } from 'shiki/core';
import { createJavaScriptRegexEngine } from 'shiki/engine/javascript';
import ts from '@shikijs/langs/typescript';
import githubDark from '@shikijs/themes/github-dark';
import { setupShikiProviderFromHighlighter } from '@aparte/plugin-shiki/core';

setupShikiProviderFromHighlighter(
  await createHighlighterCore({
    themes: [githubDark],
    langs: [ts],
    engine: createJavaScriptRegexEngine(),
  }),
);
```

这个模块没有从 `shiki` 交易是它的语法是固定的 所以是一种语言 不随身携带会像纯文本一样产生(没有按需载荷可返回).

> 仅限无害环境管理。 离相单相.

## 常见问题

### @aparte/plugin-shiki 是什么？

通过 shiki 对分的语法加亮 – 将其注册为发亮提供者\( single lazily-created signer\)\.

### 如何安装 @aparte/plugin-shiki？

在项目目录运行 npm install @aparte/plugin-shiki，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：shiki（^4\.0\.0）、@aparte/core（\>=0\.32\.1 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aparte/plugin-shiki 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aparte/plugin-shiki 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aparte/plugin-shiki 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aparte/plugin-shiki 可以商用吗？

@aparte/plugin-shiki 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aparte/plugin-shiki 的下载量有多少？

根据 npm 官方下载统计，@aparte/plugin-shiki 在 2026/10/06 – 2026/11/04 这 30 天内被下载 5,343 次，日均约 178 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aparte/plugin-shiki 还在维护吗？

最新版本 0\.32\.1 发布于 2026/11/02（4 天前）；至今共发布 65 个版本，其中过去 12 个月发布了 65 个；首次发布于 2026/07/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。