在做前端团队建设过程中,相关文档越来越多,所以迫切需要有一个地方来存储这些文档。在对比了几个框架之后,最终选择了使用vuepress构建静态资源网站。
优点:
1、vue系,大家比较熟悉
2、界面优美,直接使用vue官网一样的风格。
3、文档基于markDown,可移植。
准备:
1、请基于vuepress中文文档,完成项目安装和构建,地址:https://vuepress.vuejs.org/zh/guide/getting-started.html
2、本篇文章只会把自己认为的几个核心模块拿出来和大家分享下:
核心模块:
1、目录结构
2、config.js文件配置:
const path = require('path');
module.exports = {
base:'/',// 仓库名,表示部署到哪里
title: 'DataHub前端文档',// 网页左上角标题名,也是主页标题
description: '基于Vue Press的前端研发文档,前端编码规范文档', // 描述,是主页副标题
head: [
['link', {
rel: 'icon', href: '/img/logo.png' }]
],// 引入标签页小图标 应该是个.ico
themeConfig: {
// repo: 'xxxx',// 默认是 false, 设置为 true 来启用,右上角会出现 github 跳转链接
logo: &