vuepress 使用说明
2022年1月9日...大约 2 分钟
vuepress && vuepress-theme-hope使用说明
常用的 frontmatter
文章使用
---
# 这是文章的标题
title: 页面配置
# You can customize cover image
cover: /assets/images/cover1.jpg
# 这是页面的图标
icon: page
# 这是侧边栏的顺序
order: 1
# 设置作者
author: Ms.Hope
# 设置写作时间
date: 2020-01-01
# 一个页面可以有多个分类
category:
- 使用指南
# 一个页面可以有多个标签
tag:
- 页面配置
- 使用指南
# 此页面会在文章列表置顶
sticky: true
# 此页面会出现在文章收藏中
star: true
# 你可以自定义页脚
footer: 这是测试显示的页脚
# 你可以自定义版权信息
copyright: 无版权
---
主页会使用的frontmatter
home: true
layout: BlogHome
icon: home
title: 主页
heroImage: /logo.svg
heroImageDark: /assets/icon/guide-maskable.png
heroText: Change's blog
heroFullScreen: true
tagline: 每天学习一点点,你会发现自己会的越来越少
更多 frontmatter 的使用
title
- 类型: string-
- 必填: 否
- 当前页面内容标题,默认为 Markdown 文件中的第一个 h1 标签内容。
shortTitle
- 类型: string
- 必填: 否
- 当前页面的短标题,会在导航栏、侧边栏和路径导航中作为首选。
description
- 类型: string
- 必填: 否
- 当前页面内容描述。
icon
- 类型: string
- 必填: 否
- 详情:
- 指南 → 图标支持
- 当前页面图标的 FontClass 或文件路径 (建议填写)
当前使用fontawesome
图标
ico 可用图标查询
star
- 类型: boolean | number
- 默认值: false
- 是否收藏在博客主题的文章列表中。当填入数字时,数字越大,排名越靠前。
article
- 类型: boolean
- 默认值: true
- 是否将该文章添加至文章列表中。
timeline
- 类型: boolean
- 默认值: true
- 是否将该文章添加至时间线中。
image
- 类型: string
- 必填: 否
- 设置预览图 (分享图),请填入绝对路径。
banner
- 类型: string
- 必填: 否
- 设置横幅图片 (宽屏分享图),请填入绝对路径。
常用图标
更多 icon 的使用
这里是内容。
触发 toc 设置
贡献者
changelichangyangccm@163.com