之前有很多朋友问我，我的开源项目文档网站是用什么搭建的。其实是用搭建的，具体可以参考如何写出优雅的开源项目文档 。用来搭建成体系的文档网站基本够用了，但有时候我们既有成体系的文章、又有碎片化的文章，如果把文章都挂上去，看起来未免有些凌乱，这时候我们可能需要搭建一个类似知识库的网站了。最近发现使用可以搭建一个功能强大的文档网站，推荐给大家！
实战电商项目mall（50k+star）地址：
简介
是Vue驱动的静态网站生成器。对比我们的动态生成网站，对SEO更加友好。
使用具有如下优点：
主题
一般我们使用搭建网站的时候，都会选择一个主题。这里选择的是--，一款简洁高效的知识管理&博客主题，用来搭建文档网站绰绰有余。
学了技术老忘怎么破？用搭建一个知识库试试！它能帮助我们更好地管理知识，并能够快速地把遗忘的知识点找回来。
使用主题具有如下优点：
效果演示
我们先来看下成品效果，有三种不同模式可供选择，是不是够炫酷！
搭建
通过搭建网站非常简单，就算你对Vue不熟悉也没关系。
# 安装
npm install
# 运行
npm run dev
配置
由于本身就是个完整的网站了，里面有很多我们不需要的文章和配置，所以我们得替换这些文章并自定义这些配置。
docs
│ index.md -- 首页配置
├─.vuepress -- 用于存放全局的配置、组件、静态资源等
│ │ config.js -- 配置文件的入口文件
│ │ enhanceApp.js -- 客户端应用的增强
│ ├─config
│ │ head.js -- 注入到页面中的配置
│ │ htmlModules.js -- 插入自定义html模块
│ │ nav.js -- 顶部导航栏配置
│ │ plugins.js -- 插件配置
│ │ themeConfig.js -- 主题配置
│ ├─public -- 静态资源目录
│ │ └─img -- 用于存放图片
│ ├─styles
│ │ palette.styl -- 主题演示配置
│ └─<结构化目录>
├─@pages --自动生成的文件夹
│ archivesPage.md -- 归档页
│ categoriesPage.md -- 分类页
│ tagsPage.md -- 标签页
├─images -- 可以用来存放自己的图片
└─_posts -- 专门存放碎片化博客文章的文件夹，不会自动生成目录
---
pageComponent:
name: Catalogue
data:
key: 02.mall学习教程
imgUrl: /img/ui.png
description: mall学习教程，架构、业务、技术要点全方位解析。
title: mall学习教程
date: 2020-03-11 21:50:54
permalink: /mall-learning
sidebar: false
article: false
comment: false
editlink: false
---
module.exports = [
{ text: '首页', link: '/' },
{
text: 'mall学习教程',
link: '/mall-learning/',
items: [
{ text: '序章', link: '/pages/72bed2/' },
{ text: '架构篇', link: '/pages/c68875/' },
{ text: '业务篇', link: '/pages/c981c1/' },
{ text: '技术要点篇', link: '/pages/fab7d9/' },
{ text: '部署篇', link: '/pages/db2d1e/' },
],
}
]
---
home: true
# heroImage: /img/web.png
heroText: macrozheng's blog
tagline: Java后端技术博客，积跬步以至千里，致敬每个爱学习的你。
features: # 可选的
- title: mall学习教程
details: mall学习教程，架构、业务、技术要点全方位解析。
link: /mall-learning/
imgUrl: /img/ui.png
- title: SpringCloud学习教程
details: 一套涵盖大部分核心组件使用的Spring Cloud教程，包括Spring Cloud Alibaba及分布式事务Seata。
link: /springcloud-learning/
imgUrl: /img/other.png
- title: K8S学习教程
details: 实实在在的K8S实战教程，专为Java方向人群打造！
link: /springcloud-learning/ # 可选
imgUrl: /img/web.png # 可选
---
---
title: mall整合SpringBoot+MyBatis搭建基本骨架
date: 2021-08-19 16:30:11
permalink: /pages/c68875/
categories:
- mall学习教程
- 架构篇
tags:
- SpringBoot
- MyBatis
---
如果你仔细看下文章列表的话，可以发现有的文章会显示摘要，而有的不会显示，我们可以通过注释来控制摘要的显示，该注释之前内容均会作为摘要来显示；
// 主题配置
module.exports = {
nav,
sidebarDepth: 2, // 侧边栏显示深度，默认1，最大2（显示到h3标题）
logo: '/img/avatar.png', // 导航栏logo
repo: 'macrozheng', // 导航栏右侧生成Github链接
searchMaxSuggestions: 10, // 搜索结果显示最大数
lastUpdated: '上次更新', // 开启更新时间，并配置前缀文字 string | boolean (取值为git提交时间)
docsDir: 'docs', // 编辑的文件夹
editlinks: false, // 启用编辑
editlinkText: '编辑',
sidebar: { mode: 'structuring', collapsable: false}, // 侧边栏 'structuring' | { mode: 'structuring', collapsable: Boolean} | 'auto' | 自定义 温馨提示：目录页数据依赖于结构化的侧边栏数据，如果你不设置为'structuring',将无法使用目录页
author: {
// 文章默认的作者信息，可在md文件中单独配置此信息 String | {name: String, link: String}
name: 'macrozheng', // 必需
link: 'https://github.com/macrozheng', // 可选的
},
blogger: {
// 博主信息，显示在首页侧边栏
avatar: '/img/avatar.png',
name: 'macrozheng',
slogan: '这家伙很懒，什么都没写...',
},
social: {
// 社交图标，显示于博主信息栏和页脚栏
// iconfontCssFile: '//at.alicdn.com/t/font_1678482_u4nrnp8xp6g.css', // 可选，阿里图标库在线css文件地址，对于主题没有的图标可自由添加
icons: [
{
iconClass: 'icon-github',
title: 'GitHub',
link: 'https://github.com/macrozheng',
},
{
iconClass: 'icon-gitee',
title: 'Gitee',
link: 'https://gitee.com/macrozheng',
},
{
iconClass: 'icon-juejin',
title: '掘金',
link: 'https://juejin.cn/user/958429871749192',
}
],
},
footer: {
// 页脚信息
createYear: 2019, // 博客创建年份
copyrightInfo:
'marcozheng | MIT License', // 博客版权信息，支持a标签
},
htmlModules // 插入html模块
}
// 插件配置
module.exports = [
[
'vuepress-plugin-baidu-tongji', // 百度统计
false, //禁用
{
hm: 'xxx',
},
],
]
// 浅色模式
.theme-mode-light
// 代码块浅色主题
//--codeBg: #f6f6f6
//--codeColor: #525252
//codeThemeLight()
// 代码块深色主题
--codeBg: #252526
--codeColor: #fff
codeThemeDark()
部署
生成网站也非常简单，一个命令完成打包，然后放置到的html目录下即可。
总结
使用+来搭建文档网站不仅炫酷而且功能强大！对比的动态生成文档，生成静态页面性能更好，同时对SEO也更友好。 如果你只想搭建简单的单项目文档的话，基本上也够用了。如果你想搭建多项目文档，或者博客网站的话，还是推荐你使用的。
参考资料 项目地址
本文 已经收录，欢迎大家Star！
