vuepress-theme-vdoing vuepress-theme-vdoing
首页
  • 主题初衷与诞生
  • 介绍
  • 快速上手
  • 目录结构
  • 核心配置和约定
  • 自动生成front matter
  • Markdown 容器
  • Markdown 中使用组件
  • 相关文章

    • 如何让你的笔记更有表现力
    • 批量操作front matter工具
    • 部署
    • 关于写文章和H1标题
    • 关于博客搭建与管理
    • 在线编辑和新增文章的方法
  • 主题配置
  • 首页配置
  • front matter配置
  • 目录页配置
  • 添加摘要
  • 修改主题颜色和样式
  • 评论栏
插件
案例
问答
💖支持
反馈
GitHub (opens new window)
首页
  • 主题初衷与诞生
  • 介绍
  • 快速上手
  • 目录结构
  • 核心配置和约定
  • 自动生成front matter
  • Markdown 容器
  • Markdown 中使用组件
  • 相关文章

    • 如何让你的笔记更有表现力
    • 批量操作front matter工具
    • 部署
    • 关于写文章和H1标题
    • 关于博客搭建与管理
    • 在线编辑和新增文章的方法
  • 主题配置
  • 首页配置
  • front matter配置
  • 目录页配置
  • 添加摘要
  • 修改主题颜色和样式
  • 评论栏
插件
案例
问答
💖支持
反馈
GitHub (opens new window)
  • 配置

    • 主题配置
      • 是否打开分类、标签、归档
        • category
        • tag
        • archive
        • 使用分类页、标签页、归档页链接
      • 碎片化博文默认分类值
        • categoryText
      • body背景大图
        • bodyBgImg
        • bodyBgImgOpacity
      • 文章标题前的图标
        • titleBadge
        • titleBadgeIcons
      • 文章内容块的背景底纹
        • contentBgStyle
      • 侧边栏
        • sidebar
        • sidebarOpen
        • 对指定页面禁用侧边栏
        • 碎片化博文的侧边栏
      • 最近更新栏
        • updateBar
        • 非文章页的设置
      • 右侧文章大纲栏
        • rightMenuBar
      • 快捷翻页按钮
        • pageButton
      • 文章作者信息
        • author
        • 指定的文章作者信息
      • 博主信息
        • blogger
      • 社交图标
        • social
        • 主题内置的社交图标
      • 页脚版权栏
        • footer
      • 自定义html模块
        • htmlModules
    • 首页配置
    • front matter配置
    • 目录页配置
    • 添加摘要
    • 修改主题颜色和样式
    • 评论栏

主题配置

主题的配置在.vuepress/config.js文件的themeConfig字段中,是在原有配置的基础上新增或修改的配置,配置示例请查看:config.js (opens new window)。

更多官方配置,请查看vurpress文档 (opens new window)。

# 是否打开分类、标签、归档

# category

  • 类型:boolean
  • 默认值:true

是否打开分类功能。 如打开,会做的事情有:

  1. 自动生成的front matter包含分类字段
  2. 页面中显示与分类相关的信息和模块
  3. 自动生成分类页面(在@pages文件夹)

如关闭,则反之。

# tag

  • 类型:boolean
  • 默认值:true

是否打开标签功能。 如打开,会做的事情有:

  1. 自动生成的front matter包含标签字段
  2. 页面中显示与标签相关的信息和模块
  3. 自动生成标签页面(在@pages文件夹)

如关闭,则反之。

# archive

  • 类型:boolean
  • 默认值:true

是否打开归档功能。 如打开,会做的事情有:

  1. 自动生成归档页面(在@pages文件夹)

如关闭,则反之。

提示

如果你仅仅是想使用这个主题来搭建知识库,并不想使用分类、标签、归档功能,就可以关闭它们。

# 使用分类页、标签页、归档页链接

当你打开了分类、标签、归档功能,就可以在导航或其他地方添加分类页、标签页、归档页的链接:

  • 分类页: /categories/
  • 标签页: /tags/
  • 归档页: /archives/

# 碎片化博文默认分类值

# categoryText

  • 类型:string
  • 默认值:'随笔'

碎片化博文(_posts文件夹的文章)默认生成的分类值

# body背景大图

# bodyBgImg

  • 类型:string | array
  • 默认值:undefined

body背景大图,单张图片使用String,多张图片使用Array, 多张图片时每隔15秒换一张

# bodyBgImgOpacity v1.4.0 +

  • 类型:number
  • 默认值:0.5
  • 选值范围:0 ~ 1.0

body背景图透明度

# 文章标题前的图标

# titleBadge

  • 类型:boolean
  • 默认值:true

是否打开文章标题图标

# titleBadgeIcons

  • 类型:array
  • 默认值:内置图标

文章标题图标的地址

# 文章内容块的背景底纹

# contentBgStyle v1.4.0 +

  • 类型:number
  • 默认值:undefined
  • 选值:1 => 方格 | 2 => 横线 | 3 => 竖线 | 4 => 左斜线 | 5 => 右斜线 | 6 => 点状

文章内容块的背景底纹

# 侧边栏

# sidebar

  • 类型:srting | object | array
  • 在默认主题原有的配置上新增两项参数:
    • 'structuring' 自动生成结构化侧边栏
    • { mode: 'structuring', collapsable: Boolean} 自动生成结构化侧边栏,并设置侧边栏是否可折叠,默认true

提示

如需构建结构化站点请把此配置设置为structuring 或 { mode: 'structuring', collapsable: false}

# sidebarOpen

  • 类型:boolean
  • 默认值:true

初始状态下是否打开侧边栏

提示

在侧边栏关闭状态下,页面向下滚动时会隐藏顶部导航栏,让用户更专注于阅读。

# 对指定页面禁用侧边栏

你可以通过 front matter 来禁用指定页面的侧边栏:

---
sidebar: false
---
1
2
3

# 碎片化博文的侧边栏

在_posts文件夹的文章会自动在 front matter 添加 sidebar: auto

---
sidebar: auto
---
1
2
3

# 最近更新栏

# updateBar

  • 类型:object
  • 默认值:{showToArticle: true, moreArticle: '/archives/'}
    • showToArticle 显示到文章页底部,默认true
    • moreArticle “更多文章”跳转的页面,默认'/archives/'

最近更新栏,显示于文章页底部和简约版首页文章列表

# 非文章页的设置

对于非文章页,如目录页、关于、友情链接等自定义页面,最好在front matter设置article: false,设置之后这个页面将被认定为非文章页,不显示面包屑和作者、时间,不显示最近更新栏,不会参与到最近更新文章的数据计算中。

---
article: false
---
1
2
3

# 右侧文章大纲栏

# rightMenuBar v1.6.3 +

  • 类型:boolean
  • 默认值:true

是否显示右侧文章大纲栏。设置为false或屏宽小于1300px时,文章大纲将与左侧侧边栏混合在一起。 (注:在屏宽小于1300px下无论如何都不显示右侧文章大纲栏。)

# 快捷翻页按钮

# pageButton v1.4.3 +

  • 类型:boolean
  • 默认值:true

是否显示快捷翻页按钮 (此按钮是文章页左右两边的箭头按钮,小屏中不会显示。)

# 文章作者信息

# author

  • 类型:string | {name: String, link: String}
  • 默认值:undefined
    • name 作者名称
    • link 作者链接

文章默认的作者信息

# 指定的文章作者信息

你也可以在指定的文章front matter设置作者信息,优先级比默认作者信息高,示例:

---
author:
  name: 作者名
  link: https://xxx.com
---
 或
---
author: 作者名
---
1
2
3
4
5
6
7
8
9

# 博主信息

# blogger

  • 参数和类型:{avatar: String, name: String, slogan: String}
  • 默认值:undefined
    • avatar 头像,必需
    • name 博主名称,必需
    • slogan 标语,可选

博主信息显示于首页博主信息栏

# 社交图标

# social

  • 参数和类型:{iconfontCssFile: String, icons: [{iconClass: String, title: String, link: String}]}
  • 默认值:undefined
    • iconfontCssFile 可选,阿里图标库(或其他)的在线css字体图标文件地址,对于主题没有的图标可自由添加
    • icons 图标列表,数量自由
      • iconClass 图标的Class名称
      • title 图标的title
      • link 图标的跳转链接

社交图标显示于博主信息栏和页脚栏

# 主题内置的社交图标 v1.2.2+, 部分v1.7.2+

微信

icon-weixin

QQ

icon-QQ

邮件

icon-youjian

npm

icon-npm

github

icon-github

gitee

icon-gitee

微博

icon-weibo

知乎

icon-zhihu

语雀

icon-yuque

豆瓣

icon-douban

掘金

icon-juejin

简书

icon-jianshu

思否

icon-sf

博客园

icon-bokeyuan

CSDN

icon-csdn

v2ex

icon-v2ex

抖音

icon-douyin

哔哩哔哩

icon-bilibili

youtube

icon-youtube

facebook

icon-facebook

twitter

icon-twitter

telegram

icon-telegram

RSS

icon-rss

耳机

icon-erji

猫咪

icon-mao

书本

icon-shuben

相册

icon-xiangce

# 页脚版权栏

# footer

  • 参数和类型:{createYear: Number | String, copyrightInfo: String}
  • 默认值:undefined
    • createYear 博客创建的年份
    • copyrightInfo 博客版权信息,支持a标签

页脚版权栏信息,原默认主题在首页的front matter中的footer配置项已弃用。

# 自定义html模块

可用于插入广告模块

# htmlModules v1.7.0 +

  • 类型:object

  • 默认值:undefined

  • 属性:

    • homeSidebarB 首页侧边栏底部
    • sidebarT 全局左侧边栏顶部
    • sidebarB 全局左侧边栏底部
    • pageT 全局页面顶部
    • pageB 全局页面底部
    • pageTshowMode 页面顶部-显示方式
      • 未配置 默认全局显示
      • 'article' 仅文章页①显示
      • 'custom' 仅自定义页①显示
    • pageBshowMode 页面底部-显示方式
      • 未配置 默认全局显示
      • 'article' 仅文章页①显示
      • 'custom' 仅自定义页①显示
    • windowLB 全局窗口左下角②
    • windowRB 全局窗口右下角②

    ①注:在.md文件front matter配置article: false的页面是自定义页,未配置的默认是文章页(首页除外)。

    ②注:windowLB 和 windowRB:1.展示区块宽高最大是200*200px。2.请给自定义元素定一个不超过200px的固定宽高。3.在屏宽小于960px时无论如何都不会显示。

  • 格式:

htmlModules: {
   homeSidebarB: htmlString,
   sidebarT: htmlString,
   sidebarB: htmlString,
   pageT: htmlString,
   pageB: htmlString,
   pageTshowMode: string,
   pageBshowMode: string,
   windowLB: htmlString,
   windowRB: htmlString,
 }
1
2
3
4
5
6
7
8
9
10
11
上次更新: 2020/12/25, 15:05:36
首页配置

首页配置→

Theme by Vdoing | Copyright © 2019-2021 Evan Xu | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×