Shiki项目中如何使用codeToHtml结合transformerMetaHighlight实现代码高亮
2025-05-20 15:19:04作者:裴锟轩Denise
在代码高亮工具Shiki中,开发者经常需要实现特定行号的高亮效果。本文将详细介绍如何通过codeToHtml方法和transformerMetaHighlight转换器来实现这一功能。
核心概念解析
Shiki提供了codeToHtml方法用于将代码转换为HTML格式,同时支持通过transformerMetaHighlight转换器处理元数据高亮。这种组合方式特别适合需要精确控制代码行高亮的场景。
实现方法
要使用meta高亮功能,需要按照以下方式配置:
import { codeToHtml } from 'shiki'
import { transformerMetaHighlight } from '@shikijs/transformers'
const code = 'const a = 1'
const html = await codeToHtml(code, {
lang: 'javascript',
theme: 'vitesse-dark',
transformers: [
transformerMetaHighlight()
],
meta: {
__raw: '{1,3-4}' // 高亮第1行和第3-4行
}
})
实现原理
- meta参数中的__raw属性用于传递原始元数据字符串
- transformerMetaHighlight会解析这个字符串中的行号信息
- 解析后的行号会被转换为对应的HTML class
- 最终生成的HTML会包含这些高亮行的特殊样式
注意事项
- 行号范围使用逗号分隔不同行或行范围
- 行范围使用短横线连接起始和结束行号
- 该方法不直接支持Markdown/MDX语法,仅处理纯代码高亮
- 对于更复杂的高亮需求,建议考虑使用专门的notation转换器
替代方案
如果项目中使用的是Markdown或MDX,建议使用rehype-shiki等集成方案,这些方案能更好地处理代码块中的元数据。但对于纯JavaScript环境下的代码高亮需求,上述方法是最直接有效的解决方案。
通过这种方式,开发者可以灵活地控制代码高亮效果,为技术文档或代码展示提供更好的视觉体验。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
247
2.45 K
deepin linux kernel
C
24
6
仓颉编译器源码及 cjdb 调试工具。
C++
116
89
React Native鸿蒙化仓库
JavaScript
217
297
暂无简介
Dart
546
119
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.01 K
595
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
409
Ascend Extension for PyTorch
Python
85
118
仓颉编程语言运行时与标准库。
Cangjie
124
102
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
592
121