主题页面
blog
md
---
layout: blog
---在 md 文档中将 layout 设置为 blog,会渲染主题的博客首页,有以下效果:
- 展示博客列表
- 展示首页花园区、最新文章和快捷入口
- 展示作者信息(头像、名称,需要配置)
- 展示浏览量
- 展示分类
- 展示标签
该页面不会展示md文档其他内容
category
md
---
layout: category
---在 md 文档中将 layout 设置为 category,会渲染分类筛选页,有以下效果:
- 分类列表
- 文章列表
- 点选某个分类筛选文章
tag
md
---
layout: tag
---在 md 文档中将 layout 设置为 tag,会渲染标签筛选页,有以下效果:
- 标签列表
- 文章列表
- 点选某个标签筛选文章
filter
md
---
layout: filter
---在 md 文档中将 layout 设置为 filter,会在同一页提供分类和标签筛选,有以下效果:
- 分类列表
- 标签列表
- 文章列表
- 点选某个标签筛选文章
timeline
md
---
layout: timeline
---在 md 文档中将 layout 设置为 timeline,会渲染时间线页面,有以下效果:
- 按照时间排序的文章列表
doc
md
---
layout: doc
---doc为vitepress默认主题中的配置,即显示文档时的默认选择,本主题扩充了该页面的参数,使用时设置为doc
type
md
---
layout: doc
type: widen // [!code ++]
---如果type为widen,页面内容宽度更宽
导航页
导航页可以使用组件 web-list 组织项目、工具或外部链接,以下是一个通用配置案例:
md
---
layout: doc
type: widen
title: 导航
---
<script setup>
const list = [
{
title: "Project Docs",
icon: "github",
desc: "项目说明文档",
link: "https://github.com/example/project-docs",
},
{
title: "Live Demo",
icon: "github",
desc: "在线演示地址",
link: "https://example.com/demo",
},
];
</script>
<web-list :list />web-list 参数说明
| 参数名 | 说明 |
|---|---|
| title | 标题 |
| icon | github,demo |
| desc | 描述 |
| link | 链接 |
