Skip to content

Commit 893fe64

Browse files
author
Florens Verschelde
committed
doc(readme): improve doc for svg task, sass task, multiple builds
1 parent 917c5ef commit 893fe64

File tree

1 file changed

+43
-12
lines changed

1 file changed

+43
-12
lines changed

README.md

+43-12
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,12 @@ Task script: `gulp/builders/sass.js`
6969
// (Optional) File patterns to watch for changes
7070
watch: 'assets/styles/**/*.scss',
7171
// (Optional) Autoprefixer: target browsers
72-
browsers: ['last 3 versions']
72+
browsers: ['last 3 versions'],
73+
// (Optional) Sass output style
74+
// Defaults to 'compressed', can also be: 'nested', 'expanded', 'compact'
75+
outputStyle: 'compressed',
76+
// (Optional) Sass include paths (for @import)
77+
includePaths: []
7378
}
7479
```
7580

@@ -106,25 +111,51 @@ Task script: `gulp/builders/svgsprite.js`
106111
// (Optional) File patterns to watch for changes, or `true`
107112
// to use the same value as the src property
108113
watch: true,
114+
// (Optional) Output a SVG file fit for inlining in a HTML page; defaults to false
115+
inline: true,
116+
// (Optional) Prefix symbol id attributes; no prefix by default
117+
prefix: 'shape-'
109118
}
110119
```
111120

112-
### More than one build per task?
121+
### Several builds per task
113122

114-
Each task can accept several config objects, to output several result files. You need to provide a full config object for each `dest` file.
123+
Each task can accept several config objects, using the `builds` property. You can provide an array of complete config objects in the `builds` property, or let it inherit from the task’s config:
115124

116125
```js
117126
{
118127
…,
119-
jsconcat: [
120-
{ src: 'assets/scripts/topic1/*.js',
121-
dest: 'public/svg/main.svg',
122-
watch: true
123-
},
124-
{ src: 'assets/scripts/topic2/*.js',
125-
dest: 'public/svg/main.svg'
126-
}
127-
],
128+
sass: {
129+
dest: 'public/css',
130+
browsers: ['last 3 versions', 'ie >= 11'],
131+
builds: [
132+
{ src: 'assets/styles/main.scss', watch: 'assets/styles/**/*.scss' },
133+
{ src: 'assets/styles/other.scss', outputStyle: 'compact' }
134+
]
135+
},
136+
137+
}
138+
```
139+
140+
is equivalent to:
141+
142+
```js
143+
{
144+
…,
145+
sass: {
146+
builds: [
147+
{ src: 'assets/styles/main.scss',
148+
watch: 'assets/styles/**/*.scss',
149+
dest: 'public/css',
150+
browsers: ['last 3 versions', 'ie >= 11']
151+
},
152+
{ src: 'assets/styles/other.scss',
153+
dest: 'public/css',
154+
browsers: ['last 3 versions', 'ie >= 11'],
155+
outputStyle: 'compact',
156+
}
157+
]
158+
},
128159
129160
}
130161
```

0 commit comments

Comments
 (0)