Skip to content

基于gulp构建的官网项目脚手架

Notifications You must be signed in to change notification settings

lgwebdream/gulp-website

 
 

Repository files navigation

基于gulp构建的官网项目脚手架


项目简介

  1. 项目基于gulp、babel7构建
  2. 使用ejs开发静态页面,支持国际化开发
  3. js支持commenjs规范以及esm规范
  4. 使用sass预处理css,使用postcss处理浏览器后缀
  5. 使用browser-sync构建开发环境,使用http-proxy-middleware处理请求代理

如何运行

  1. 基本配置文件:复制user.config.js.config文件并改名为user.config.js
  2. 安装依赖:执行npm install或者yarn
  3. 基本命令
//开发环境
npm start||npm run dev
//构建打包
npm run build

处理html

  • 添加html页面,以及打包配置
  1. 在/src/html/文件夹中添加对应页面
  2. 修改/gulp/task/html.js文件htmlConfig配置
  • 打包国际化页面
  1. 在/src/lang/文件夹中添加对应语言文件
  2. 修改/gulp/task/html.js文件htmlConfig配置
  3. 例如index.html页面会被打包为index.htm(中文)index-en.html(英文)页面

处理js

  • 添加js文件以及打包配置
  1. /src/js/文件夹中添加对应js入口文件
  2. 修改/gulp/task/js.js文件entries配置
  • html引入js文件
  1. 参照index.js文件引入方式,构建后会自动添加hash值
  2. 外部库引入,参照jquery文件的引入

处理css

  • 添加scss文件以及引入css文件
  1. /src/css/文件夹中添加对应scss文件
  2. html中参照index.css文件引入方式

处理图片

  • 图片放在/src/imgs/文件夹中
  • html、scss中引入图片,使用相对于文件方式引入,构建后会替换路径
<img src="../imgs/123.jpeg" alt="">

项目结构

├── README.md
├── dev     //开发环境打包代码
├── dist    //生产环境打包代码
├── favicon.ico
├── gulp    //gulp配置
├── gulpfile.babel.js   //babel配置
├── package.json
├── src
│   ├── html    //index入口文件
│   │   ├── ejs
│   │   │   └── footer.ejs
│   │   └── index.html
│   ├── imgs    //图片
│   │   └── 123.jpeg
│   ├── js  //js
│   │   ├── index.js
│   │   └── moduleA.js
│   ├── lang    //国际化语言文件
│   │   ├── en.json
│   │   └── zh-cn.json
│   ├── scss    //sass文件
│   │   ├── common
│   │   │   └── _reset.scss
│   │   └── index.scss
│   └── static  //静态文件
│       └── jquery-3.2.1.min.js
└── user.config.js.config   //开发配置文件

About

基于gulp构建的官网项目脚手架

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 82.8%
  • CSS 10.0%
  • HTML 7.2%