@aparte/plugin-shiki

中文文档
0.32.1发布于 2026/11/02MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 5343

Syntax highlighting for aparté via shiki — register it as the highlight provider (single lazily-created highlighter).

原始使用文档

@aparte/plugin-shiki

Syntax highlighting for aparté via shiki. Registers shiki as the highlight provider, backed by a single lazily-created highlighter — grammars and the theme load on demand and are cached, so you never re-initialise per code block.

npm install @aparte/plugin-shiki @aparte/core shiki
import { setupShikiProvider } from '@aparte/plugin-shiki';

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

@aparte/core and shiki are peer dependencies. setupShikiProvider is async — await it once at startup before rendering highlighted messages.

Two entry points, because size is a choice

Loading is lazy either way: a grammar is fetched the first time that language appears, and an unknown language degrades to plain text instead of throwing.

Shipping is not. The import above pulls in shiki, whose bundle maps every known language to a dynamic import, so your bundler emits one file per grammar — measured on a build that imported nothing else:

you importfiles emittedweight
@aparte/plugin-shiki30211 MB
@aparte/plugin-shiki/core (3 grammars)1560 kB

An option listing the languages would not change that — a static import is a static import (measured: still 302 files). So if what you ship matters, build the highlighter yourself and hand it over:

Those fine-grained entry points live in separate packages — add them alongside shiki:

npm install @shikijs/langs @shikijs/themes
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(),
  }),
);

That module imports nothing from shiki — the trade is that its grammars are fixed, so a language it does not carry renders as plain text (no on-demand load to fall back on).

ESM-only. Part of the aparté monorepo.

版本与发布记录

@aparte/plugin-shiki 共发布 65 个版本,首次发布于 2026/07/24;过去 12 个月发布了 65 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.32.1latest2026/11/024 天前
0.32.02026/11/024 天前
0.31.02026/11/024 天前
0.30.12026/11/014 天前
0.30.02026/11/014 天前
0.29.42026/11/015 天前

其他发布通道:alpha → 0.17.0。

关于 @aparte/plugin-shiki 的常见问题

@aparte/plugin-shiki 是什么?

Syntax highlighting for aparté via shiki — register it as the highlight provider (single lazily-created highlighter).

如何安装 @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 和提交记录判断。