You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,43 +48,45 @@ gulp.task('default', function () {
48
48
49
49
##Options
50
50
51
-
###cssPathNoSvg
51
+
####cssPathNoSvg
52
+
52
53
Type: `string`
53
54
Default: `<empty>`
54
55
55
56
Optional. CSS `background-image` path for the non-SVG fallback image, which will be output in the `templateDest` file. The path should be relative to that final destination file. The mustache template can ignore an empty value. To generate a fallback image you must use a plugin of your choice (e.g. gulp-svg2png) and pipe in the SVG as per the complex example above.
56
57
57
-
###cssPathSvg
58
+
####cssPathSvg
59
+
58
60
Type: `string`
59
61
Default: `./test.svg`
60
62
61
63
CSS `background-image` path which will be used in the `templateDest` file. The path should be relative to that final destination file.
62
64
63
-
###demoDest
65
+
####demoDest
64
66
Type: `string`
65
67
Default: `<empty>`
66
68
67
69
Optional. A demo file can be created showing all of the SVGs within the spritesheet. A sample is provided in the `test` folder and can be customised however you like. If you do not require a demo file then leave this option empty.
68
70
69
-
###demoSrc
71
+
####demoSrc
70
72
Type: `string`
71
73
Default: `../demo.tpl`
72
74
73
75
Optional. The source mustache template file used to create the `demoDest` file. Only used when `demoDest` is not empty.
74
76
75
-
###padding
77
+
####padding
76
78
Type: `integer`
77
79
Default: `0`
78
80
79
81
Add padding around the individual sprites. Value is pixel based.
80
82
81
-
###pixelBase
83
+
####pixelBase
82
84
Type: `integer`
83
85
Default: `16`
84
86
85
87
Optional. Used if anything other than `px` is specified in `units` to calculate relative units.
86
88
87
-
###positioning
89
+
####positioning
88
90
Type: `integer`
89
91
Default: `vertical`
90
92
@@ -95,31 +97,31 @@ Allows icons to be layed out in one of several ways:
95
97
*`diagonal` – cascading from top left to bottom right
96
98
*`packed` – like Compass' smart layout option
97
99
98
-
###templateDest
100
+
####templateDest
99
101
Type: `string`
100
102
Default: `./sprite.scss`
101
103
102
104
The destination of the sprite sheet CSS generated from `templateSrc`.
103
105
104
-
###templateSrc
106
+
####templateSrc
105
107
Type: `string`
106
108
Default: `./template.tpl`
107
109
108
110
A mustache template file used to output the sprite sheet CSS.
109
111
110
-
###units
112
+
####units
111
113
Type: `string`
112
114
Default: `px`
113
115
114
116
CSS background size and position units of measurement. If a value other than `px` is specified (`em` or `rem`) then pixel values will be converted to relative units using `pixelBase`.
115
117
116
-
###x
118
+
####x
117
119
Type: `integer`
118
120
Default: `0`
119
121
120
122
Offset the starting X position on the sprite sheet.
0 commit comments