基础使用
插入图片
外部图片
直接使用标准 Markdown 语法引用网络图片:
markdown

本地图片
方式一:绝对路径
将图片放在项目根目录的 public/ 下,构建时会原样复制到站点根目录,使用绝对路径引用:
public/
images/
vitepress-logo-mini.svgmarkdown
方式二:相对路径
将图片放在与文章相同的目录下,使用相对路径引用,VitePress 会自动处理打包:
posts/
basic-usage.md
vitepress-logo-mini.svg ← 与文章同级markdown
指定图片大小
VitePress 支持通过 HTML 控制尺寸:
html
<img src="./vitepress-logo-mini.svg" width="80" alt="logo" />图片居中
html
<img src="./vitepress-logo-mini.svg" width="80" style="display:block;margin:0 auto" alt="logo" />图片画廊组件
本站内置了 ImageGallery Vue 组件,支持并排展示、网格排列、轮播模式,图例自动取文件名(去掉扩展名)。点击任意图片可全屏放大(Lightbox),按 Esc 或点击背景关闭。
用法
html
<ImageGallery :images="['/images/a.png', '/images/b.png']" />参数说明
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
images | string | string[] | — | 图片路径,单张或数组 |
layout | 'row' | 'grid' | 'uniform' | 'row' | 排列方式,见下方说明 |
rowHeight | number | 280 | row / uniform 模式下图片的统一高度(px),宽度按原图比例自适应 |
maxWidth | number | 320 | grid 模式下每张图片的最大宽度(px) |
layout 取值说明:
row(默认):所有图片固定同等高度、宽度按比例自适应地水平并排展示。若宽度不足以在同一行放下所有图片,自动切换为轮播模式。grid:换行网格,每张图片最大宽度由maxWidth控制。uniform:强制轮播模式,无论图片数量多少。
轮播模式
自动触发或使用 layout="uniform" 时进入轮播模式:
- 当前图居中显示,左右相邻图从侧面露出,透明度降低
- 点击左右按钮或点击侧面的图片可切换
- 点击当前图可全屏放大
示例:并排展示
html
<ImageGallery :images="['/images/vitepress-logo-mini.svg', '/images/vitepress-logo-mini.svg']" />示例:指定高度
html
<ImageGallery :images="['/images/vitepress-logo-mini.svg', '/images/vitepress-logo-mini.svg']" :rowHeight="120" />示例:强制轮播
html
<ImageGallery :images="['/images/vitepress-logo-mini.svg', '/images/vitepress-logo-mini.svg']" layout="uniform" :rowHeight="120" />数学公式
本站使用 MathJax 渲染 LaTeX 公式。
行内公式
用 $...$ 包裹行内公式。
markdown
欧拉恒等式:$e^{i\pi} + 1 = 0$效果:欧拉恒等式:
块级公式
用 $$...$$ 包裹独立成行的公式。
二次方程求根公式:
latex
$$
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$正态分布概率密度函数:
矩阵:
求和与积分:
图表组件
本站内置了 BenchmarkChart Vue 组件,可在任意 Markdown 文章中直接使用,无需 import。
用法
在 Markdown 中插入以下标签:
html
<BenchmarkChart
title="图表标题"
:labels="['A', 'B', 'C', 'D']"
:series="[
{ name: '方案一', color: '#e05c5c', values: [10, 20, 30, 40] },
{ name: '方案二', color: '#56c26e', values: [5, 25, 50, 100] },
]"
unit="ms"
/>参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
title | string | 图表标题,显示在左上角 |
labels | string[] | X 轴刻度标签数组 |
series | object[] | 数据系列,每项含 name(名称)、color(颜色)、values(数值数组) |
unit | string | 数值单位,显示在 tooltip 中 |
示例效果
示例:两组数据对比
悬停数据点查看详情
方案一
方案二
线性 / 对数轴切换
图表右上角提供「线性」与「对数」两种坐标轴模式,点击可切换。
当各方案数值相差数量级时(如性能基准测试),切换到对数轴可清晰展示各方案间的差异:
对数轴示例:跨越多个数量级
悬停数据点查看详情
方案一 SingleAtomic
方案二 HashShard
方案三 ThreadLocal
TIP
悬停在数据点上可查看该列所有方案的精确数值。