Skip to content

Commit 386219f

Browse files
committed
Update readme.md
1 parent 0dea8ba commit 386219f

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

readme.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -48,43 +48,45 @@ gulp.task('default', function () {
4848

4949
##Options
5050

51-
###cssPathNoSvg
51+
####cssPathNoSvg
52+
5253
Type: `string`
5354
Default: `<empty>`
5455

5556
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.
5657

57-
###cssPathSvg
58+
####cssPathSvg
59+
5860
Type: `string`
5961
Default: `./test.svg`
6062

6163
CSS `background-image` path which will be used in the `templateDest` file. The path should be relative to that final destination file.
6264

63-
###demoDest
65+
####demoDest
6466
Type: `string`
6567
Default: `<empty>`
6668

6769
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.
6870

69-
###demoSrc
71+
####demoSrc
7072
Type: `string`
7173
Default: `../demo.tpl`
7274

7375
Optional. The source mustache template file used to create the `demoDest` file. Only used when `demoDest` is not empty.
7476

75-
###padding
77+
####padding
7678
Type: `integer`
7779
Default: `0`
7880

7981
Add padding around the individual sprites. Value is pixel based.
8082

81-
###pixelBase
83+
####pixelBase
8284
Type: `integer`
8385
Default: `16`
8486

8587
Optional. Used if anything other than `px` is specified in `units` to calculate relative units.
8688

87-
###positioning
89+
####positioning
8890
Type: `integer`
8991
Default: `vertical`
9092

@@ -95,31 +97,31 @@ Allows icons to be layed out in one of several ways:
9597
* `diagonal` – cascading from top left to bottom right
9698
* `packed` – like Compass' smart layout option
9799

98-
###templateDest
100+
####templateDest
99101
Type: `string`
100102
Default: `./sprite.scss`
101103

102104
The destination of the sprite sheet CSS generated from `templateSrc`.
103105

104-
###templateSrc
106+
####templateSrc
105107
Type: `string`
106108
Default: `./template.tpl`
107109

108110
A mustache template file used to output the sprite sheet CSS.
109111

110-
###units
112+
####units
111113
Type: `string`
112114
Default: `px`
113115

114116
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`.
115117

116-
###x
118+
####x
117119
Type: `integer`
118120
Default: `0`
119121

120122
Offset the starting X position on the sprite sheet.
121123

122-
###y
124+
####y
123125
Type: `integer`
124126
Default: `0`
125127

0 commit comments

Comments
 (0)