Skip to content

Commit 8664639

Browse files
authored
Merge pull request #10 from atufkas/doc-linefeeds-revert
Reverted line feeds to markdown line breaks.
2 parents 5d2ed1b + 65d9f03 commit 8664639

File tree

1 file changed

+16
-30
lines changed

1 file changed

+16
-30
lines changed

README.md

+16-30
Original file line numberDiff line numberDiff line change
@@ -60,97 +60,86 @@ gulp.task('default', function () {
6060

6161
#### options.width
6262

63-
Type: `Number`
64-
63+
Type: `Number`
6564
Default value: `0` (only if height is defined)
6665

6766
A number value that is passed as pixel or percentage value to imagemagick.
6867

6968

7069
#### options.height
7170

72-
Type: `Number`
73-
71+
Type: `Number`
7472
Default value: `0` (only if width is defined)
7573

7674
A number value that is passed as pixel or percentage value to imagemagick.
7775

7876

7977
#### options.upscale
8078

81-
Type: `Boolean`
82-
79+
Type: `Boolean`
8380
Default value: `false`
8481

8582
Determines whether images will be upscaled. If set to `false` (default), image will be copied instead of resized if it would be upscaled by resizing.
8683

8784

8885
#### options.crop
8986

90-
Type: `Boolean`
91-
87+
Type: `Boolean`
9288
Default value: `false`
9389

9490
Determines whether images will be cropped after resizing to exactly match `options.width` and `options.height`.
9591

9692

9793
#### options.gravity
9894

99-
Type: `String`
100-
101-
Default value: `Center`
95+
Type: `String`
96+
Default value: `Center`
10297
Possible values: `NorthWest`, `North`, `NorthEast`, `West`, `Center`, `East`, `SouthWest`, `South`, `SouthEast`
10398

10499
When cropping images this sets the image gravity. Doesn't have any effect, if `options.crop` is `false`.
105100

106101

107102
#### options.quality
108103

109-
Type: `Number`
110-
104+
Type: `Number`
111105
Default value: `1`
112106

113107
Determines the output quality of the resized image. Ranges from `0` (really bad) to `1` (almost lossless). Only applies to jpg images.
114108

115109

116110
#### options.format
117111

118-
Type: `String`
119-
120-
Default value: Format of the input file
112+
Type: `String`
113+
Default value: Format of the input file
121114
Possible values: `gif`, `png`, `jpeg` etc.
122115

123116
Override the output format of the processed file.
124117

125118
#### options.filter
126119

127-
Type: `String`
128-
120+
Type: `String`
129121
Possible values: `Point`, `Box`, `Triangle`, `Hermite`, `Hanning`, `Hamming`, `Blackman`, `Gaussian`, `Quadratic`, `Cubic`, `Catrom`, `Mitchell`, `Lanczos`, `Bessel`, `Sinc`
130122

131123
Set the filter to use when resizing (e.g. Catrom is very good for reduction, while hermite is good for enlargement).
132124

133125
#### options.sharpen
134126

135-
Type: `Boolean | String`
136-
127+
Type: `Boolean | String`
137128
Default value: `false`
138129

139130
Set to `true` to apply a slight unsharp mask after resizing.
140131
Or set a string to setup the unsharp. See [gm unsharp documentation](http://www.graphicsmagick.org/GraphicsMagick.html#details-unsharp). (e.g. '0.5x0.5+0.5+0.008')
141132

142133
#### options.samplingFactor
143134

144-
Type: `Array[Cr, Cb]`
145-
135+
Type: `Array[Cr, Cb]`
146136
Possible values: `[2, 2]` for 4:2:2, `[1, 1]` for 4:1:1
147137

148138
Define chroma subsampling
149139

150140
#### options.noProfile
151141

152-
Type: `Boolean`
153-
142+
Type: `Boolean`
154143
Default value: `false`
155144

156145
Set to `true` to enforce removal of all embedded profile data like icc, exif, iptc, xmp
@@ -160,25 +149,22 @@ cases where thumbnails are generated for web preview purposes. For details look
160149

161150
#### options.imageMagick
162151

163-
Type: `Boolean`
164-
152+
Type: `Boolean`
165153
Default value: `false`
166154

167155
Set to `true` when using ImageMagick instead of GraphicsMagick.
168156

169157
### options.background
170158

171-
Type: `String`
172-
159+
Type: `String`
173160
Possible values: `none` to keep transparency, `beige` to set beige background, `#888` for gray.
174161

175162
Define background color (default is white), for example when converting SVG images to PNGs.
176163
See [gm background documentation](http://www.graphicsmagick.org/GraphicsMagick.html#details-background)
177164

178165
### options.flatten
179166

180-
Type: `Boolean`
181-
167+
Type: `Boolean`
182168
Default value: `false`
183169

184170
Combines image layers into one. Can be used for layered formats such as PNG. See [gm flatten documentation](http://www.graphicsmagick.org/GraphicsMagick.html#details-flatten).

0 commit comments

Comments
 (0)