本站介绍
# 本站介绍
先来看看几个网站:
VUE官方文档 (opens new window)
ElementUI官方文档 (opens new window)
大圣前端编程自学网 (opens new window)
Vdoing作者Evans'blog (opens new window)
看起来是不是都有些相似,没错,它们都是基于 VuePress 1.x (opens new window) 编写的
提示
VuePress 2.x (opens new window) 和 基于vue3跟vite的 VitePress (opens new window) 还在完善中。
本站正是使用 VuePress 1.x (opens new window)框架,继承自 Vdoing (opens new window)主题,搭建而成。源码地址 (opens new window)
# VuePress介绍
VuePress 由两部分组成:第一部分是一个极简静态网站生成器,它包含由 Vue 驱动的主题系统和插件 API,
另一个部分是为书写技术文档而优化的默认主题,它的诞生初衷是为了支持 Vue 及其子项目的文档需求。
事实上,一个 VuePress 网站是一个由 Vue、Vue Router 和 webpack 驱动的单页应用。
在构建时,会为应用创建一个服务端渲染(SSR)的版本,然后通过虚拟访问每一条路径来渲染对应的HTML。
内置 Markdown 拓展,支持在 Markdown 中 使用 Vue
内置默认主题,支持自定义主题,支持插件
可生成在线文档,博客网站
更详细的介绍请看官网介绍 (opens new window)
# Vdoing介绍
Vdoing (opens new window) 全称是 vuepress-theme-vdoing
,是在 VuePress 1.x (opens new window) 的 默认主题 (opens new window)基础上修改和扩展而来的,使用此主题可以很方便的搭建一个结构化的知识库或博客。
这个主题简洁高效,专为阅读设计的UI,配合多种颜色模式,可以轻松搭建一个面向程序员的知识管理博客
更详细的介绍请看官网介绍 (opens new window)
# 本站主题
本站所使用的主题是继承自Vdoing,在其基础上做了少部分修改,主要如下:
# 新增主题配置项
# navBefore
- 类型:
array
- 默认值:
[]
配置顶部位于搜索框前的导航标签项,如本站顶部导航的 🔑索引
# repoLink
- 类型:
boolean
- 默认值:
true
是否在导航栏右侧生成Github链接。 用于在配置了repo,以便能在底部生成在线修改链接,又不想在顶部导航栏右侧生成Github链接,可设置为 false
(毕竟不太好看, 可以放到其他地方下)
提示
配置为true时,也需要配置 repo 才有效,即主题配置 themeConfig 中的 repo 配置了对应的仓库链接
# 新增首页配置项
# category
- 类型:
boolean
- 默认值:
true
是否显示侧边栏分类框。 用于在打开分类功能时,又不想显示在主页,可设置为 false
提示
配置为true时,也需要打开分类功能才会显示,即主题配置 themeConfig 中的 category 配置为 true
# tag
- 类型:
boolean
- 默认值:
true
是否显示侧边栏标签框。 用于在打开标签功能时,又不想显示在主页,可设置为 false
提示
配置为true时,也需要打开标签功能才会显示,即主题配置 themeConfig 中的 tag 配置为 true
# 其他
其他代码上的修改在后面中介绍