页面配置-布局与功能

more 注释之前的内容被视为文章摘要。

页面信息

你可以在 Markdown 的 Frontmatter 中设置页面信息。

• 作者设置为 Megestus
• 写作日期为 2020 年 1 月 1 日
• 分类为 “使用指南”
• 标签为 “页面配置” 和 “使用指南”

页面内容

你可以自由在这里书写你的 Markdown。

提示

• 你可以将图片和 Markdown 文件放置在一起，但是你需要使用相对链接./ 进行引用。

• 对于 .vuepress/public 文件夹的图片，请使用绝对链接 / 进行引用。

主题包含了一个自定义徽章可以使用:

文字结尾应该有深蓝色的 徽章文字 徽章。 徽章文字

页面结构

此页面应当包含:

• 路径导航
• 标题和页面信息
• TOC (文章标题列表)
• 贡献者、更新时间等页面元信息
• 评论
• 导航栏
• 侧边栏
• 页脚
• 返回顶部按钮

你可以通过主题选项和页面 Frontmatter 自定义它们。

布局与功能禁用

你可以通过设置页面的 Frontmatter，在页面禁用功能与布局。

禁用设置:

布局功能	描述	false\true
article:	你可以自定义是否显示在home页	false\true
navbar:	导航栏	false\true
sidebar:	侧边栏	false\true
breadcrumb:	路径导航	false\true
pageInfo:	页面信息	false\true
contributors:	贡献者	false\true
editLink:	编辑此页链接	false\true
lastUpdated:	更新时间	false\true
prev:	上一篇 链接	false\true
next:	下一篇 链接	false\true
comment:	评论	false\true
footer:	页脚	test
backtotop:	返回顶部按钮	false\true
copyright:	定义版权	Copyright © 2024 Megestus
star:	此页面会出现在文章收藏中	false\true
sticky:	此页面会在文章列表置顶	false\true

VuePress 项目结构

一个基本的项目结构如下:

.
├── .github (可选的) → GitHub 配置文件存放路径
│    └── workflow → GitHub 工作流配置
│         └── docs-deploy.yml → 自动部署文档的工作流
│
├── src → 文档文件夹
│    │
│    ├── .vuepress (可选的) → VuePress 配置文件夹
│    │    │
│    │    ├── dist (默认的) → 构建输出目录
│    │    │
│    │    ├── public (可选的) → 静态资源目录
│    │    │
│    │    ├── styles (可选的) → 用于存放样式相关的文件
│    │    │
│    │    ├── config.{js,ts} (可选的) → 配置文件的入口文件
│    │    │
│    │    └── client.{js,ts} (可选的) → 客户端文件
│    │
│    ├── ... → 其他项目文档
│    │
│    └── README.md → 项目主页
│
└── package.json → Nodejs 配置文件