Skip to content

Commit

Permalink
Updated SVG compiling process
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Ferdinandi committed May 14, 2015
1 parent 050e810 commit ed40306
Show file tree
Hide file tree
Showing 19 changed files with 19 additions and 22 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Make sure these are installed first.
Add your files to the appropriate `src` subdirectories. Gulp will process and and compile them into `dist`.

* Content in subdirectories under the `js` folder will be concatenated. For example, files in `js/detects` will compile into `detects.js`. Files directly under `js` will compile individually.
* SVGs in the `svg` directory will compile into `icons.svg`.
* SVGs in the `svg` subdirectories of the `svg` directory will compile into `icons.svg`.
* Assets in the `assets` directory will be copied as-is into the `dist` directory.

```
Expand Down Expand Up @@ -127,7 +127,9 @@ Unit test results are printed in terminal, but you can also view them in a brows

### SVGs

SVG files placed in the `src` > `svg` directory will be compiled into a single SVG sprite called `icons.svg` in the `dist` > `svg` directory.
SVG files placed in the `src` > `svg` directory will be optimized with SVGO and compiled into `dist` > `svg` as-is.

SVG files placed in subdirectories of `src` > `svg` will be ocmpiled into a single SVG sprite named after the parent directory. For example, files in `src` > `svg` > `icons` would compile into a single `icons.svg` file.

### Documentation

Expand Down
2 changes: 1 addition & 1 deletion dist/css/myplugin.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* gulp-boilerplate v1.3.2
* gulp-boilerplate v2.0.0
* My Gulp.js boilerplate for creating new web projects, by Chris Ferdinandi.
* http://github.com/cferdinandi/Plugin
*
Expand Down
2 changes: 1 addition & 1 deletion dist/css/myplugin.min.css
Original file line number Diff line number Diff line change
@@ -1 +1 @@
/** gulp-boilerplate v1.3.2, by Chris Ferdinandi | http://github.com/cferdinandi/Plugin | Licensed under MIT: http://gomakethings.com/mit/ */
/** gulp-boilerplate v2.0.0, by Chris Ferdinandi | http://github.com/cferdinandi/Plugin | Licensed under MIT: http://gomakethings.com/mit/ */
2 changes: 1 addition & 1 deletion dist/js/classList.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* gulp-boilerplate v1.3.2
* gulp-boilerplate v2.0.0
* My Gulp.js boilerplate for creating new web projects, by Chris Ferdinandi.
* http://github.com/cferdinandi/Plugin
*
Expand Down
2 changes: 1 addition & 1 deletion dist/js/classList.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/js/myplugin.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* gulp-boilerplate v1.3.2
* gulp-boilerplate v2.0.0
* My Gulp.js boilerplate for creating new web projects, by Chris Ferdinandi.
* http://github.com/cferdinandi/Plugin
*
Expand Down
2 changes: 1 addition & 1 deletion dist/js/myplugin.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion dist/svg/icons.svg

This file was deleted.

1 change: 1 addition & 0 deletions dist/svg/placeholder.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/dist/css/myplugin.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* gulp-boilerplate v1.3.2
* gulp-boilerplate v2.0.0
* My Gulp.js boilerplate for creating new web projects, by Chris Ferdinandi.
* http://github.com/cferdinandi/Plugin
*
Expand Down
2 changes: 1 addition & 1 deletion docs/dist/css/myplugin.min.css
Original file line number Diff line number Diff line change
@@ -1 +1 @@
/** gulp-boilerplate v1.3.2, by Chris Ferdinandi | http://github.com/cferdinandi/Plugin | Licensed under MIT: http://gomakethings.com/mit/ */
/** gulp-boilerplate v2.0.0, by Chris Ferdinandi | http://github.com/cferdinandi/Plugin | Licensed under MIT: http://gomakethings.com/mit/ */
2 changes: 1 addition & 1 deletion docs/dist/js/classList.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* gulp-boilerplate v1.3.2
* gulp-boilerplate v2.0.0
* My Gulp.js boilerplate for creating new web projects, by Chris Ferdinandi.
* http://github.com/cferdinandi/Plugin
*
Expand Down
2 changes: 1 addition & 1 deletion docs/dist/js/classList.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/dist/js/myplugin.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* gulp-boilerplate v1.3.2
* gulp-boilerplate v2.0.0
* My Gulp.js boilerplate for creating new web projects, by Chris Ferdinandi.
* http://github.com/cferdinandi/Plugin
*
Expand Down
2 changes: 1 addition & 1 deletion docs/dist/js/myplugin.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion docs/dist/svg/icons.svg

This file was deleted.

1 change: 1 addition & 0 deletions docs/dist/svg/placeholder.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 0 additions & 5 deletions gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -166,11 +166,6 @@ gulp.task('build:svgs', ['clean:dist'], function () {
}
}))
.pipe(svgmin())
.pipe(svgstore({
fileName: 'icons.svg',
prefix: 'icon-',
inlineSvg: true
}))
.pipe(gulp.dest(paths.svgs.output));
});

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "gulp-boilerplate",
"version": "1.3.2",
"version": "2.0.0",
"description": "My Gulp.js boilerplate for creating new web projects",
"main": "./dist",
"author": {
Expand Down

0 comments on commit ed40306

Please sign in to comment.