Skip to content

关于本站

本站基于 VitePress 框架,套用了一个尚在开发中(貌似原作者已删库跑路)的博客主题。实现了一些基本的功能,也是博主所珍视的功能,例如宽屏显示文章内容,自动生成导航侧边栏;也有很多尚不完善的功能,比如,在未来值得期待和添加的一些特色功能如下:

  • 白天/黑夜 模式的黑夜模式基本没有怎么设置 CSS 样式
  • 缺少一个分类页面 Categories
  • 缺少一个标签页面 Tags
  • setFrontmatter.js 自动添加内容的功能尚不完全

以下是本贴的正文,也是本站建站的使用指南。

文件夹主页

自建空白项目

您现在正在阅读的这个页面,它是基于一级文件夹 /about/ 下的 index.md 渲染而成。根据博客现有的功能,所有这些 index.md 文档必须通过手动一个一个按需添加。未来或许可以考虑通过代码批量生成。

文件夹内的 index.md 主页,如果配置使用,有以下几点需要注意:

  1. 文件的名称必须是 index.md,不可以使用其他名称
  2. index.md 创建之后,运行项目 pnpm run docs:build 时,会在文档顶部自动添加 frontmatter 并包含三项内容:
    • title 自动生成 index 做为标题,建议手动更改为父级文件夹的名称,该名称会被用作生成左侧边栏的名称
    • date 文章生成时间
    • order 如果使用数字前缀组织文档顺序,留空即可;如果使用 order 组织文档顺序,按照“数字越大,排序靠后”原则

复制自其他项目

经过测试,在当前 clone 下来的项目中,直接添加来自 Vdoing 项目的一级文件夹之后:

  1. 每个级别的文件夹内,都需要一一手动添加一个 index.md 文件
  2. config/nav/ 文件夹内,添加配置文件
  3. config/sidebar/ 文件夹内,添加配置文件
  4. config/nav.ts 文件内,添加配置项
  5. config/sidebar.ts 文件内,添加配置项

这样配置之后,在导航栏可以添加一个新增一级文件夹的入口。如果不需要更改导航栏,只需配置第 3、5 项。

分类页面

常见的那种 Categories 页面。

标签页面

常见的那种 Tags 页面。

首页文章列表

在首页上呈现一个文章列表,由新到旧,实现分页功能。

私密文章

Vdoing 主题已有一个实现,可以借鉴。