Build Scripts

When using BaseWeb source, you’ll need to utilize a method for compiling and minifying SCSS and JavaScript files. BaseWeb leverages Gulp for its build process. To use our Gulp tasks, clone the repo and run the npm install command:

# Clone BaseWeb
git clone https://github.com/sebnitu/BaseWeb.git

# Navigate into the repository
cd baseweb

# Install node packages
npm install

Available Tasks

Task Description
Source Tasks
gulp css Output expanded and min CSS files with source maps from src into dist
gulp js Output expanded and minified JS files from src into dist
gulp icons Copies icons from Feather Icons with custom classes and SVG sprite into dist/icons
gulp src ['css', 'js', 'icons']
Documentation Tasks
gulp docs:css Output expanded and min CSS files with source maps from docs/src into docs/dist
gulp docs:js Output expanded and minified JS files from docs/src into docs/dist
gulp docs:img Compress all image files from docs/src into docs/dist
gulp docs:icons Copies icons from Feather Icons with custom classes and SVG sprite into docs/_includes/icons
gulp docs ['docs:css', 'docs:js', 'docs:img', 'docs:icons']
Global Tasks
gulp svg ['icons', 'docs:icons']
gulp go ['src', 'docs', 'svg']
gulp watch Watch all asset files and runs the appropriate build task based on changes
gulp ['go', 'watch']
Utility Tasks
gulp replace Search and replace for managing current version and other static data that changes accross multiple files: -s SEARCH -r REPLACE -f FILES
gulp data:icons Writes all the icon svg files as a data object in icons.json for Jekyll

All of BaseWeb's build tasks are located in gulpfile.js. Check out Gulp's documentation for how to create your own builds.

© 2018 . All rights reserved.