团队文档在线管理,非常实用的vuepress

本文介绍了在前端团队文档管理中,如何利用VuePress构建一个静态资源网站。VuePress因其Vue系背景、美观界面和Markdown支持而被选择。文章详细讲解了项目安装、核心模块如目录结构、config.js配置,以及图片加载方法,帮助读者快速上手。
摘要由CSDN通过智能技术生成

在做前端团队建设过程中,相关文档越来越多,所以迫切需要有一个地方来存储这些文档。在对比了几个框架之后,最终选择了使用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: &
  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值