此页内容

约 464 字大约 2 分钟

2022-04-09

提示

以下内容中,以 sourceDir 表示 项目中用于保存 Markdown 文件的目录。

package.jsonscripts 中配置的 vuepress dev src,则表示 sourceDirsrc 目录

约定

使用本主题编写文章是一件很轻松的事情,你可以在 sourceDir目录中按照你的个人命名喜好新建任意名字的Markdown文件, 主题将会自动帮你生成一个文章永久链接,并保存在文章的配置中,以便随时修改。

对于 sourceDir 中的文件夹命名,主题有一套简单的约定。

  • 文件夹的名称将作为 category分类
  • 允许多级目录,子级目录将作为父目录对应的分类的子项。
  • 如果目录名称 在 主题配置 notes 中声明用于 notes 文章管理,则默认不作为 分类目录。

文件夹命名约定

由于文件夹名称将作为分类名称,且不在主题配置中进行排序配置,对于有排序需要的场景,使用以下规则进行命名

const dir = /\d+\.[^]+/
// 即 数字 + . + 分类名称
// 如: 1.前端

数字将作为 排序 的依据。 如果不带数字,则以默认的规则进行排序。

example:

 .{sourceDir}
  - 1.前端
    - 1.html
    - 2.css
    - 3.javascript
  - 2.后端
  - 运维

文章写作

你可以使用 markdown 语法开始在 sourceDir 下新建 Markdown 文件,编写你自己的文章了, 关于 markdown 扩展的功能支持,请查看 这个文档

文章列表页

主题将会自动生成为一个 地址为/blog/ 的文章列表页面,展示所有的文章。

需要将它手动配置到 navbar 选项中。