渲染测试页
该页面用于验证主题内置的 Markdown 扩展与插件是否工作正常。按照各小节描述逐一检查,可快速确认自定义主题在本地或部署环境中的表现。
本页面隐藏了aside
1. Demo 容器与示例组件
下面的 Demo 使用 vitepress-better-demo-plugin 生成,重点关注:
- 预览区是否成功渲染
packages/docs/demo/demo.vue。 - 右上角是否出现代码折叠、复制、StackBlitz/CodeSandbox/GitHub/GitLab 按钮。
- 展开代码后,
vueTab 默认为选中,语法高亮是否正常。
<template>
<div>测试Demo页 <a href="#">vp-raw 测试链接</a></div>
</template>2. 代码块标题图标(vitepress-plugin-group-icons)
单个代码块会根据标题里的关键字自动注入图标:
pnpm add vitepress-theme-element-plus多语言代码组同样支持关键字或指定 Iconify 名称(如 ~logos:vitejs~),保存后 Vite 会热刷新 virtual:group-icons.css:
import Theme from 'vitepress-theme-element-plus'
import { createApp } from 'vue'pnpm -C packages/docs dev3. 标签、Tooltip 与外部链接
^(beta)^(deprecated)等语法应渲染为彩色徽标。- ^[prop-name]`string` 应生成
<api-typing>组件以展示类型信息。 - 外部链接会自动带有图标并套用
vp-link样式,比如 Element Plus 官网。
示例段落:
该功能目前 beta,属性
color接受color(string),若需要更多信息请访问 Element Plus 官网。
4. API 表格与滚动容器
mdTableWrapper 会为表格添加 .vp-table 包裹层,确保在窄屏下出现横向滚动条。检查表格线条、悬停状态与 Tooltip 交互:
| 属性 | 描述 | 默认值 |
|---|---|---|
size a11y deprecated | Enum | default |
zIndex 1.1.0 | 弹层层级,支持 number,超过 2000 可避免被遮挡 | 2000 |
teleported beta | 是否将弹层挂载到 body,验证标签与 Tooltip 混合显示 | true |
5. 提示块与列表
vitepress-theme-element-plus 继承 VitePress 的自定义块样式,下方用于验证标题、正文与列表对齐是否符合预期:
检查项
- 切换浅色/深色模式,确认配色一致。
- 缩放浏览器宽度,确保响应式间距正常。
- 使用本页所有交互(复制代码、折叠 Demo 等)以排查潜在脚本错误。
警告
- 切换浅色/深色模式,确认配色一致。
- 缩放浏览器宽度,确保响应式间距正常。
- 使用本页所有交互(复制代码、折叠 Demo 等)以排查潜在脚本错误。
完成以上检查后,即可确认主题的主要渲染能力正常工作。如需扩展新的测试项,可按相同模式增加段落,保持“说明 + 预期行为”的结构即可。
6. Markdown 语法示例
该分节集中展示 VitePress 默认 Markdown 语法的渲染效果,方便检查基础格式是否受主题样式影响。
无序与有序列表
- 使用
-、*或+开头都应渲染为无序列表项。 - 列表项之间保留 4px 间距,嵌套段落需继承行高。
- 二级列表应缩进对齐,行内代码如
const foo = 'bar'需保持等宽字体。
- 二级列表应缩进对齐,行内代码如
- 列表中可继续插入 粗体、斜体、或
删除线。
- 有序列表应自动编号。
- 多位数编号要与段落左对齐。
- 结合 外部链接 或
kbd样式验证颜色与状态。
引用与嵌套内容
一级引用块用于突出段落。
可以在内部继续嵌套引用,并包含列表:
文字强调与行内元素
文本中的 粗体、斜体、inline code、以及 链接文字 应继承主题主色。使用 上标 或 下标 等语法也应正常显示。内联 MathJax(如
分隔线与定义列表
在段落之间插入三条横线可生成分隔线,检查上下间距:
术语一 : 定义内容应靠左对齐,并保持与段落相同的字体大小。
术语二 : 可包含多行文本,若换行则在左侧与首行对齐。