Vitepress 默认主题中支持在站点标题中使用 HTML 标签
2025-05-15 10:06:51作者:胡易黎Nicole
在 Vitepress 文档站点开发过程中,站点标题(siteTitle)是一个重要的展示元素。默认情况下,Vitepress 会对站点标题中的 HTML 标签进行转义处理,这限制了开发者对标题样式的自定义能力。
当前限制
Vitepress 的默认主题目前会将 siteTitle 配置中的 HTML 标签自动转义。例如,如果开发者尝试在标题中添加版本标签:
OI Runner++ <span class="VPBadge tip">v1.0.0</span>
实际渲染时会显示为转义后的文本:
OI Runner++ <span class="VPBadge tip">v1.0.0</span>
这导致无法实现一些常见的标题样式需求,比如在标题旁添加徽章(badge)效果。
技术背景
Vitepress 作为基于 Vue 的静态站点生成器,其默认主题出于安全考虑会对用户输入的文本内容进行转义处理,防止潜在的 XSS(跨站脚本)攻击。然而,对于 siteTitle 这样的配置项,由于是在构建时确定的静态内容,实际上不存在安全风险。
解决方案建议
可以考虑修改 Vitepress 默认主题的实现,使 siteTitle 配置支持 HTML 标签,类似于首页布局(Home layout)中 hero 部分的处理方式。具体来说:
- 移除对 siteTitle 的 HTML 转义处理
- 使用 v-html 指令而非文本插值来渲染标题
- 在文档中明确说明此功能支持 HTML
这种改动不会引入安全风险,因为:
- siteTitle 是在构建时确定的配置项
- 内容完全由开发者控制
- 不像用户生成内容那样存在注入风险
实际应用场景
支持 HTML 标签的站点标题可以实现多种效果:
- 版本徽章:在标题旁显示版本号标签
- 样式定制:为标题的不同部分应用不同样式
- 图标集成:在标题中嵌入 SVG 图标
- 响应式设计:在不同屏幕尺寸下显示不同的标题内容
实现考量
虽然这个功能看似简单,但在实现时需要考虑:
- 向后兼容性:确保现有项目不受影响
- 文档更新:明确说明此功能的使用方法和限制
- 性能影响:评估使用 v-html 带来的性能变化
- 主题定制:考虑如何让自定义主题也能利用此功能
这种改进将增强 Vitepress 的灵活性,同时保持其安全性和易用性。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
GLM-4.7-FlashGLM-4.7-Flash 是一款 30B-A3B MoE 模型。作为 30B 级别中的佼佼者,GLM-4.7-Flash 为追求性能与效率平衡的轻量化部署提供了全新选择。Jinja00
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin07
compass-metrics-modelMetrics model project for the OSS CompassPython00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
520
3.7 K
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
67
20
暂无简介
Dart
762
183
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.32 K
740
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
16
1
React Native鸿蒙化仓库
JavaScript
301
348
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
1