主题配置
主题配置
主题的配置在.vuepress/config.ts
文件的themeConfig
字段中,是在原有配置的基础上做的新增和修改,配置示例请查看:config.ts (opens new window)。
详细信息
/**
* 提示:如您想使用JS版本的配置文件可参考:https://github.com/xugaoyi/vuepress-theme-vdoing/tree/a2f03e993dd2f2a3afdc57cf72adfc6f1b6b0c32/docs/.vuepress
*/
import { resolve } from 'path'
import { defineConfig4CustomTheme, UserPlugins } from 'vuepress/config'
import { VdoingThemeConfig } from 'vuepress-theme-vdoing/types'
import dayjs from 'dayjs'
import baiduCode from './config/baiduCode' // 百度统计hm码
import htmlModules from './config/htmlModules' // 自定义插入的html块
const DOMAIN_NAME = 'xugaoyi.com' // 域名 (不带https)
const WEB_SITE = `https://${DOMAIN_NAME}` // 网址
export default defineConfig4CustomTheme<VdoingThemeConfig>({
theme: 'vdoing', // 使用npm主题包
// theme: resolve(__dirname, '../../vdoing'), // 使用本地主题包
locales: {
'/': {
lang: 'zh-CN',
title: "Evan's blog",
description: 'web前端技术博客,专注web前端学习与总结。JavaScript,js,ES6,TypeScript,vue,React,python,css3,html5,Node,git,github等技术文章。',
}
},
// base: '/', // 默认'/'。如果你想将你的网站部署到如 https://foo.github.io/bar/,那么 base 应该被设置成 "/bar/",(否则页面将失去样式等文件)
// 主题配置
themeConfig: {
// 导航配置
nav: [
{ text: '首页', link: '/' },
{
text: '前端',
link: '/web/', //目录页链接,此处link是vdoing主题新增的配置项,有二级导航时,可以点击一级导航跳到目录页
items: [
// 说明:以下所有link的值只是在相应md文件头部定义的永久链接(不是什么特殊编码)。另外,注意结尾是有斜杠的
{
text: '前端文章',
items: [
{ text: 'JavaScript', link: '/pages/8143cc480faf9a11/' },
],
},
{
text: '学习笔记',
items: [
{ text: '《JavaScript教程》', link: '/note/javascript/' },
{ text: '《JavaScript高级程序设计》', link: '/note/js/' },
{ text: '《ES6 教程》', link: '/note/es6/' },
{ text: '《Vue》', link: '/note/vue/' },
{ text: '《React》', link: '/note/react/' },
{
text: '《TypeScript 从零实现 axios》',
link: '/note/typescript-axios/',
},
{
text: '《Git》',
link: '/note/git/',
},
{
text: 'TypeScript',
link: '/pages/51afd6/',
},
{
text: 'JS设计模式总结',
link: '/pages/4643cd/',
},
],
},
],
},
{
text: '页面',
link: '/ui/',
items: [
{ text: 'HTML', link: '/pages/8309a5b876fc95e3/' },
{ text: 'CSS', link: '/pages/0a83b083bdf257cb/' },
],
},
{
text: '技术',
link: '/technology/',
items: [
{ text: '技术文档', link: '/pages/9a7ee40fc232253e/' },
{ text: 'GitHub技巧', link: '/pages/4c778760be26d8b3/' },
{ text: 'Nodejs', link: '/pages/117708e0af7f0bd9/' },
{ text: '博客搭建', link: '/pages/41f87d890d0a02af/' },
],
},
{
text: '更多',
link: '/more/',
items: [
{ text: '学习', link: '/pages/f2a556/' },
{ text: '面试', link: '/pages/aea6571b7a8bae86/' },
{ text: '心情杂货', link: '/pages/2d615df9a36a98ed/' },
{ text: '实用技巧', link: '/pages/baaa02/' },
{ text: '友情链接', link: '/friends/' },
],
},
{ text: '关于', link: '/about/' },
{
text: '收藏',
link: '/pages/beb6c0bd8a66cea6/',
// items: [
// { text: '网站', link: '/pages/beb6c0bd8a66cea6/' },
// { text: '资源', link: '/pages/eee83a9211a70f9d/' },
// { text: 'Vue资源', link: '/pages/12df8ace52d493f6/' },
// ],
},
{
text: '索引',
link: '/archives/',
items: [
{ text: '分类', link: '/categories/' },
{ text: '标签', link: '/tags/' },
{ text: '归档', link: '/archives/' },
],
},
],
sidebarDepth: 2, // 侧边栏显示深度,默认1,最大2(显示到h3标题)
logo: '/img/logo.png', // 导航栏logo
repo: 'xugaoyi/vuepress-theme-vdoing', // 导航栏右侧生成Github链接
searchMaxSuggestions: 10, // 搜索结果显示最大数
lastUpdated: '上次更新', // 开启更新时间,并配置前缀文字 string | boolean (取值为git提交时间)
docsDir: 'docs', // 编辑的文件夹
// docsBranch: 'master', // 编辑的文件所在分支,默认master。 注意:如果你的分支是main则修改为main
editLinks: true, // 启用编辑
editLinkText: '编辑',
//*** 以下是Vdoing主题相关配置,文档:https://doc.xugaoyi.com/pages/a20ce8/ ***//
// category: false, // 是否打开分类功能,默认true
// tag: false, // 是否打开标签功能,默认true
// archive: false, // 是否打开归档功能,默认true
// categoryText: '随笔', // 碎片化文章(_posts文件夹的文章)预设生成的分类值,默认'随笔'
// pageStyle: 'line', // 页面风格,可选值:'card'卡片 | 'line' 线(未设置bodyBgImg时才生效), 默认'card'。 说明:card时背景显示灰色衬托出卡片样式,line时背景显示纯色,并且部分模块带线条边框
// bodyBgImg: [
// 'https://jsd.cdn.zzko.cn/gh/xugaoyi/image_store/blog/20200507175828.jpeg',
// 'https://jsd.cdn.zzko.cn/gh/xugaoyi/image_store/blog/20200507175845.jpeg',
// 'https://jsd.cdn.zzko.cn/gh/xugaoyi/image_store/blog/20200507175846.jpeg'
// ], // body背景大图,默认无。 单张图片 String | 多张图片 Array, 多张图片时隔bodyBgImgInterval切换一张。
// bodyBgImgOpacity: 0.5, // body背景图透明度,选值 0.1~1.0, 默认0.5
// bodyBgImgInterval: 15, // body多张背景图时的切换间隔, 默认15,单位s
// titleBadge: false, // 文章标题前的图标是否显示,默认true
// titleBadgeIcons: [ // 文章标题前图标的地址,默认主题内置图标
// '图标地址1',
// '图标地址2'
// ],
// contentBgStyle: 1, // 文章内容块的背景风格,默认无. 1 方格 | 2 横线 | 3 竖线 | 4 左斜线 | 5 右斜线 | 6 点状
// updateBar: { // 最近更新栏
// showToArticle: true, // 显示到文章页底部,默认true
// moreArticle: '/archives' // “更多文章”跳转的页面,默认'/archives'
// },
// rightMenuBar: false, // 是否显示右侧文章大纲栏,默认true (屏宽小于1300px下无论如何都不显示)
// sidebarOpen: false, // 初始状态是否打开左侧边栏,默认true
// pageButton: false, // 是否显示快捷翻页按钮,默认true
// 默认外观模式(用户未在页面手动修改过模式时才生效,否则以用户设置的模式为准),可选:'auto' | 'light' | 'dark' | 'read',默认'auto'。
// defaultMode: 'auto',
// 侧边栏 'structuring' | { mode: 'structuring', collapsable: Boolean} | 'auto' | <自定义> 温馨提示:目录页数据依赖于结构化的侧边栏数据,如果你不设置为'structuring',将无法使用目录页
sidebar: 'structuring',
// 文章默认的作者信息,(可在md文件中单独配置此信息) string | {name: string, link?: string}
author: {
name: 'xugaoyi', // 必需
link: 'https://github.com/xugaoyi', // 可选的
},
// 博主信息 (显示在首页侧边栏)
blogger: {
avatar: 'https://jsd.cdn.zzko.cn/gh/xugaoyi/image_store/blog/20200103123203.jpg',
name: 'Evan Xu',
slogan: '前端界的小学生',
},
// 社交图标 (显示于博主信息栏和页脚栏。内置图标:https://doc.xugaoyi.com/pages/a20ce8/#social)
social: {
// iconfontCssFile: '//at.alicdn.com/t/xxx.css', // 可选,阿里图标库在线css文件地址,对于主题没有的图标可自己添加。阿里图片库:https://www.iconfont.cn/
icons: [
{
iconClass: 'icon-youjian',
title: '发邮件',
link: 'mailto:894072666@qq.com',
},
{
iconClass: 'icon-github',
title: 'GitHub',
link: 'https://github.com/xugaoyi',
},
{
iconClass: 'icon-erji',
title: '听音乐',
link: 'https://music.163.com/#/playlist?id=755597173',
},
],
},
// 页脚信息
footer: {
createYear: 2019, // 博客创建年份
copyrightInfo:
'Evan Xu | <a href="https://github.com/xugaoyi/vuepress-theme-vdoing/blob/master/LICENSE" target="_blank">MIT License</a> | <a href="http://beian.miit.gov.cn/" target="_blank">桂ICP备2024034950号</a> | <img src="/img/beian.png" style="width: 15px; margin-bottom: -3px;" /> <a href="https://beian.mps.gov.cn/#/query/webSearch?code=45142202000030" rel="noreferrer" target="_blank">桂公网安备45142202000030</a>', // 博客版权信息、备案信息等,支持a标签或换行标签</br>
},
// 扩展自动生成frontmatter。(当md文件的frontmatter不存在相应的字段时将自动添加。不会覆盖已有的数据。)
extendFrontmatter: {
author: {
name: 'xugaoyi',
link: 'https://github.com/xugaoyi'
}
},
// 自定义hmtl(广告)模块
htmlModules
},
// 注入到页面<head>中的标签,格式[tagName, { attrName: attrValue }, innerHTML?]
head: [
['link', { rel: 'icon', href: '/img/favicon.ico' }], //favicons,资源放在public文件夹
[
'meta',
{
name: 'keywords',
content: '前端博客,个人技术博客,前端,前端开发,前端框架,web前端,前端面试题,技术文档,学习,面试,JavaScript,js,ES6,TypeScript,vue,python,css3,html5,Node,git,github,markdown',
},
],
['meta', { name: 'baidu-site-verification', content: '7F55weZDDc' }], // 百度统计的站长验证(你可以去掉)
['meta', { name: 'theme-color', content: '#11a8cd' }], // 移动浏览器主题颜色
// [
// 'script',
// {
// 'data-ad-client': 'ca-pub-7828333725993554',
// async: 'async',
// src: 'https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js',
// },
// ], // 网站关联Google AdSense 与 html格式广告支持(你可以去掉)
],
// 插件配置
plugins: <UserPlugins>[
[
"sitemap", // 网站地图
{
hostname: WEB_SITE,
},
],
'vuepress-plugin-baidu-autopush', // 百度自动推送
[
'vuepress-plugin-baidu-tongji', // 百度统计
{
hm: baiduCode,
},
],
// 全文搜索。 ⚠️注意:此插件会在打开网站时多加载部分js文件用于搜索,导致初次访问网站变慢。如在意初次访问速度的话可以不使用此插件!(推荐:vuepress-plugin-thirdparty-search)
// 'fulltext-search',
// 可以添加第三方搜索链接的搜索框(继承原官方搜索框的配置参数)
[
'thirdparty-search',
{
thirdparty: [
{
title: '在MDN中搜索',
frontUrl: 'https://developer.mozilla.org/zh-CN/search?q=', // 搜索链接的前面部分
behindUrl: '', // 搜索链接的后面部分,可选,默认 ''
},
{
title: '在Runoob中搜索',
frontUrl: 'https://www.runoob.com/?s=',
},
{
title: '在Vue API中搜索',
frontUrl: 'https://cn.vuejs.org/v2/api/#',
},
{
title: '在Bing中搜索',
frontUrl: 'https://cn.bing.com/search?q=',
},
{
title: '通过百度搜索本站的',
frontUrl: `https://www.baidu.com/s?wd=site%3A${DOMAIN_NAME}%20`,
},
],
}
],
[
'one-click-copy', // 代码块复制按钮
{
copySelector: ['div[class*="language-"] pre', 'div[class*="aside-code"] aside'], // String or Array
copyMessage: '复制成功', // default is 'Copy successfully and then paste it for use.'
duration: 1000, // prompt message display time.
showInMobile: false, // whether to display on the mobile side, default: false.
},
],
[
'demo-block', // demo演示模块 https://github.com/xiguaxigua/vuepress-plugin-demo-block
{
settings: {
// jsLib: ['http://xxx'], // 在线示例(jsfiddle, codepen)中的js依赖
// cssLib: ['http://xxx'], // 在线示例中的css依赖
// vue: 'https://jsd.cdn.zzko.cn/npm/vue/dist/vue.min.js', // 在线示例中的vue依赖
jsfiddle: false, // 是否显示 jsfiddle 链接
codepen: true, // 是否显示 codepen 链接
horizontal: false, // 是否展示为横向样式
},
},
],
[
'vuepress-plugin-zooming', // 放大图片
{
selector: '.theme-vdoing-content img:not(.no-zoom)', // 排除class是no-zoom的图片
options: {
bgColor: 'rgba(0,0,0,0.6)',
},
},
],
[
'vuepress-plugin-comment', // 评论
{
choosen: 'gitalk',
options: {
clientID: 'a6e1355287947096b88b',
clientSecret: 'f0e77d070fabfcd5af95bebb82b2d574d7248d71',
repo: 'blog-gitalk-comment', // GitHub 仓库
owner: 'xugaoyi', // GitHub仓库所有者
admin: ['xugaoyi'], // 对仓库有写权限的人
// distractionFreeMode: true,
pagerDirection: 'last', // 'first'正序 | 'last'倒序
id: '<%- (frontmatter.permalink || frontmatter.to.path).slice(-16) %>', // 页面的唯一标识,长度不能超过50
title: '「评论」<%- frontmatter.title %>', // GitHub issue 的标题
labels: ['Gitalk', 'Comment'], // GitHub issue 的标签
body:
'页面:<%- window.location.origin + (frontmatter.to.path || window.location.pathname) %>', // GitHub issue 的内容
},
},
],
[
'@vuepress/last-updated', // "上次更新"时间格式
{
transformer: (timestamp, lang) => {
return dayjs(timestamp).format('YYYY/MM/DD, HH:mm:ss')
},
},
],
],
markdown: {
lineNumbers: true,
extractHeaders: ['h2', 'h3', 'h4', 'h5', 'h6'], // 提取标题到侧边栏的级别,默认['h2', 'h3']
},
// 监听文件变化并重新构建
extraWatchFiles: [
'.vuepress/config.ts',
'.vuepress/config/htmlModules.ts',
]
})
更多官方配置,请查看vuepress文档 (opens new window)。
是否打开分类、标签、归档
category
- 类型:
boolean
- 默认:true
是否打开分类功能。 如打开,会做的事情有:
- 自动生成的front matter包含分类字段
- 页面中显示与分类相关的信息和模块
- 自动生成分类页面(在@pages文件夹)
如关闭,则反之。
tag
- 类型:
boolean
- 默认:true
是否打开标签功能。 如打开,会做的事情有:
- 自动生成的front matter包含标签字段
- 页面中显示与标签相关的信息和模块
- 自动生成标签页面(在@pages文件夹)
如关闭,则反之。
archive
- 类型:
boolean
- 默认:true
是否打开归档功能。 如打开,会做的事情有:
- 自动生成归档页面(在@pages文件夹)
如关闭,则反之。
NOTE
提示
如果你仅仅是想使用这个主题来搭建知识库,并不想使用分类、标签、归档功能,就可以关闭它们。
使用知识库,也可以使用此功能哦哈哈。😂
使用分类页、标签页、归档页链接
当你打开了分类、标签、归档功能,就可以在导航或其他地方添加分类页、标签页、归档页的链接:
- 分类页:
/categories/
- 标签页:
/tags/
- 归档页:
/archives/
碎片化文章默认分类值
categoryText
- 类型:
string
- 默认:'随笔'
碎片化文章(_posts文件夹的文章)默认生成的分类值
页面风格
pageStyle v1.12.0 +
- 类型:
string
- 可选值:'card' | 'line' (line在未设置bodyBgImg时才生效)
- 默认:'card'
页面风格,card
时背景显示灰色衬托出卡片样式,line
时背景显示纯色,并且部分模块带线条边框(未设置bodyBgImg时才生效)
defaultMode v1.12.3 +
- 类型:
string
- 可选值:'auto' | 'light' | 'dark' | 'read'
- 默认:'auto'
默认外观模式,用户未在页面手动修改过模式时才生效,否则以用户设置的模式为准
body背景大图
bodyBgImg
- 类型:
string
|array
- 默认:undefined
body背景大图,单张图片使用String,多张图片使用Array, 多张图片时每隔 <bodyBgImgInterval>
秒换一张
bodyBgImgOpacity v1.4.0 +
- 类型:
number
- 默认:0.5
- 选值范围:0 ~ 1.0
body背景图透明度
bodyBgImgInterval v1.12.0 +
- 类型:
number
- 默认:15
- 单位:s
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
---
碎片化文章的侧边栏
在_posts文件夹的文章会自动在 front matter 添加 sidebar: auto
---
sidebar: auto
---
最近更新栏
updateBar
类型:
object
默认:
{showToArticle: true, moreArticle: '/archives/'}
- showToArticle 显示到文章页底部,默认true
- moreArticle “更多文章”跳转的页面,默认'/archives/'
最近更新栏,显示于文章页底部和简约版首页文章列表
非文章页的设置
对于非文章页,如目录页、关于、友情链接等自定义页面,最好在front matter设置article: false
,设置之后这个页面将被认定为非文章页,不显示面包屑和作者、时间,不显示最近更新栏,不会参与到最近更新文章的数据计算中。
---
article: false
---
右侧文章大纲栏
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: 作者名
---
博主信息
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 | QQicon-QQ | 邮件icon-youjian | npmicon-npm | githubicon-github | giteeicon-gitee | 微博icon-weibo |
---|---|---|---|---|---|---|
知乎icon-zhihu | 语雀icon-yuque | 豆瓣icon-douban | 掘金icon-juejin | 简书icon-jianshu | 思否icon-sf | 博客园icon-bokeyuan |
CSDNicon-csdn | v2exicon-v2ex | 抖音icon-douyin | 哔哩哔哩icon-bilibili | youtubeicon-youtube | facebookicon-facebook | twittericon-twitter |
telegramicon-telegram | RSSicon-rss | 耳机icon-erji | 猫咪icon-mao | 书本icon-shuben | 相册icon-xiangce |
扩展自动生成front matter
extendFrontmatter v1.11.0 +
- 类型:
Object
- 默认:undefined
当.md
文件的front matter不存在extendFrontmatter内相应的字段时,将在运行开发服务dev
或打包build
时自动添加,但不会覆盖已有的数据。
例子:
extendFrontmatter: {
author: {
name: 'xugaoyi',
link: 'https://github.com/xugaoyi'
},
titleTag: '',
}
生成到front matter:
---
author:
name: xugaoyi
link: https://github.com/xugaoyi
titleTag:
---
页脚版权栏
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.展示区块最大宽高200px400px。2.请给自定义元素定一个不超过200px400px的宽高。3.在屏幕宽度小于960px时无论如何都不会显示。
格式:
htmlModules: {
homeSidebarB: htmlString,
sidebarT: htmlString,
sidebarB: htmlString,
pageT: htmlString,
pageB: htmlString,
pageTshowMode: 'article' | 'custom',
pageBshowMode: 'article' | 'custom',
windowLB: htmlString,
windowRB: htmlString,
}