Skip to content

Commit c016c4a

Browse files
BitPattyBitPatty
authored
update docs
1 parent 59d80c8 commit c016c4a

File tree

73 files changed

+1038
-785
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+1038
-785
lines changed

‎README.md‎

Lines changed: 93 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ Published under the [MIT License](https://github.com/BitPatty/imgproxy-url-build
116116
- [dpi](#dpi-imgproxy-docs)
117117
- [dpr](#dpr-imgproxy-docs)
118118
- [drawDetections](#drawdetections-imgproxy-docs)
119+
- [duotone](#duotone-imgproxy-docs)
119120
- [enforceThumbnail](#enforcethumbnail-imgproxy-docs)
120121
- [enlarge](#enlarge-imgproxy-docs)
121122
- [expires](#expires-imgproxy-docs)
@@ -133,6 +134,7 @@ Published under the [MIT License](https://github.com/BitPatty/imgproxy-url-build
133134
- [maxBytes](#maxbytes-imgproxy-docs)
134135
- [minHeight](#minheight-imgproxy-docs)
135136
- [minWidth](#minwidth-imgproxy-docs)
137+
- [monochrome](#monochrome-imgproxy-docs)
136138
- [pad](#pad-imgproxy-docs)
137139
- [page](#page-imgproxy-docs)
138140
- [pixelate](#pixelate-imgproxy-docs)
@@ -170,9 +172,9 @@ Defines the brightness, contrast, and saturation.
170172

171173
```typescript
172174
pb().adjust({
173-
brightness: 100, // optional
174-
contrast: 0.8, // optional
175-
saturation: 0.9, // optional
175+
brightness: 100, // optional
176+
contrast: 0.8, // optional
177+
saturation: 0.9 // optional
176178
});
177179
```
178180

@@ -198,7 +200,7 @@ pb().background('ff0000');
198200
pb().background({
199201
r: 255,
200202
g: 0,
201-
b: 0,
203+
b: 0
202204
});
203205
```
204206

@@ -231,7 +233,7 @@ Detects objects of the provided classes and blurs them.
231233
```typescript
232234
pb().blurDetections({
233235
sigma: 10,
234-
classNames: ['face'],
236+
classNames: ['face']
235237
});
236238
```
237239

@@ -252,7 +254,7 @@ Adds a cache buster to the imgproxy params.
252254
#### Example
253255

254256
```typescript
255-
pb().cacheBuster('abcdef123');
257+
pb().cacheBuster("abcdef123");
256258
```
257259

258260
### contrast ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#contrast-idcontrast))
@@ -273,18 +275,16 @@ Crops the image.
273275

274276
```typescript
275277
pb().crop({
276-
width: 100, // optional
277-
height: 50, // optional
278-
gravity: {
279-
// optional
280-
type: GravityType.CENTER, // required
281-
offset: {
282-
// optional
283-
x: 20, // required
284-
y: 20, // required
285-
},
286-
},
287-
});
278+
width: 100, // optional
279+
height: 50, // optional
280+
gravity: { // optional
281+
type: GravityType.CENTER, // required
282+
offset: { // optional
283+
x: 20, // required
284+
y: 20 // required
285+
}
286+
}
287+
})
288288
```
289289

290290
### disableAnimation ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/cfa4b596d1f31656f9116cc16f2a4ff7d15c2837/docs/generating_the_url.md#disable-animation-iddisable-animation))
@@ -325,7 +325,21 @@ Detects objects of the provided classes and draws their bounding boxes.
325325

326326
```typescript
327327
pb().drawDetections({
328-
classNames: ['face'],
328+
classNames: ["face"]
329+
});
330+
```
331+
332+
### duotone ([imgproxy docs](https://github.com/imgproxy/imgproxy-docs/blob/7d15484aea6a1fae5f1dfd1806b5551a4774658d/docs/usage/processing.mdx?plain=1#L429))
333+
334+
Converts the image to duotone with specified intensity and colors.
335+
336+
#### Example
337+
338+
```typescript
339+
pb().duotone({
340+
intensity: 1.0, // required
341+
color1: 'ff0000', // required
342+
color2: '00ff00' // required
329343
});
330344
```
331345

@@ -457,11 +471,11 @@ Places a gradient on the processed image.
457471

458472
```typescript
459473
pb().gradient({
460-
opacity: 1, // required
461-
color: 'ababab', // optional
462-
direction: 'up', // optional
463-
start: 0.0, // optional
464-
stop: 0.7, // optional
474+
opacity: 1, // required
475+
color: 'ababab', // optional
476+
direction: 'up', // optional
477+
start: 0.0, // optional
478+
stop: 0.7 // optional
465479
});
466480
```
467481

@@ -489,8 +503,8 @@ When `hashsum_type` is not `none`, imgproxy will calculate the hashsum of the so
489503

490504
```typescript
491505
pb().hashsum({
492-
hashsum: 'ABCDEF', // required
493-
type: HashsumType.NONE, // optional
506+
hashsum: 'ABCDEF', // required
507+
type: HashsumType.NONE // optional
494508
});
495509
```
496510

@@ -502,12 +516,12 @@ Allows redefining JPEG saving options.
502516

503517
```typescript
504518
pb().jpegOptions({
505-
progressive: boolean, // optional
506-
noSubsample: boolean, // optional
507-
trellisQuant: boolean, // optional
508-
overshootDeringing: boolean, // optional
509-
optimizeScans: boolean, // optional
510-
quantizationTable: 7, // optional
519+
progressive: boolean, // optional
520+
noSubsample: boolean, // optional
521+
trellisQuant: boolean, // optional
522+
overshootDeringing: boolean, // optional
523+
optimizeScans: boolean, // optional
524+
quantizationTable: 7 // optional
511525
});
512526
```
513527

@@ -551,6 +565,19 @@ Defines the minimum width of the resulting image.
551565
pb().minWidth(100);
552566
```
553567

568+
### monochrome ([imgproxy docs](https://github.com/imgproxy/imgproxy-docs/blob/7d15484aea6a1fae5f1dfd1806b5551a4774658d/docs/usage/processing.mdx?plain=1#L415))
569+
570+
Converts the image to monochrome.
571+
572+
#### Example
573+
574+
```typescript
575+
pb().monochrome({
576+
intensity: 0.3, // required
577+
color: 'ff0000' // optional
578+
});
579+
```
580+
554581
### pad ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#padding))
555582

556583
Applies the specified padding to the image.
@@ -559,10 +586,10 @@ Applies the specified padding to the image.
559586

560587
```typescript
561588
pb().pad({
562-
top: 100, // optional (Note: sets all other sides if not set explicitly)
563-
right: 100, // optional
564-
bottom: 10, // optional
565-
left: 10, // optional
589+
top: 100, // optional (Note: sets all other sides if not set explicitly)
590+
right: 100, // optional
591+
bottom: 10, // optional
592+
left: 10 // optional
566593
});
567594
```
568595

@@ -594,9 +621,9 @@ Allows redefining PNG saving options.
594621

595622
```typescript
596623
pb().pngOptions({
597-
interlaced: true, // optional
598-
quantize: false, // optional
599-
quantization_colors: 10, // optional
624+
interlaced: true, // optional
625+
quantize: false, // optional
626+
quantization_colors: 10 // optional
600627
});
601628
```
602629

@@ -640,9 +667,9 @@ Resizes the image.
640667

641668
```typescript
642669
pb().resize({
643-
type: ResizeType.AUTO, // optional
644-
width: 100, // optional
645-
height: 50, // optional
670+
type: ResizeType.AUTO, // optional
671+
width: 100, // optional
672+
height: 50 // optional
646673
});
647674
```
648675

@@ -749,13 +776,12 @@ Trims the image background.
749776

750777
```typescript
751778
pb().trim({
752-
threshold: 10, // required
753-
color: 'ffffff', // optional
754-
equal: {
755-
// optional
756-
horizontal: true, // optional
757-
vertical: true, // optional
758-
},
779+
threshold: 10, // required
780+
color: 'ffffff', // optional
781+
equal: { // optional
782+
horizontal: true, // optional
783+
vertical: true // optional
784+
}
759785
});
760786
```
761787

@@ -767,9 +793,9 @@ Allows redefining unsharpening options.
767793

768794
```typescript
769795
pb().unsharpen({
770-
mode: UnsharpeningMode.AUTO, // optional
771-
weight: 11, // optional
772-
dividor: 24, // optional
796+
mode: UnsharpeningMode.AUTO, // optional
797+
weight: 11, // optional
798+
dividor: 24 // optional
773799
});
774800
```
775801

@@ -795,22 +821,22 @@ pb().videoThumbnailSecond(3);
795821

796822
### videoThumbnailTile ([imgproxy docs](https://github.com/imgproxy/imgproxy-docs/blob/676c6d4b1f5d9fee79abfecf130fc7dda3f9124e/versioned_docs/version-3.24.x/usage/processing.mdx#video-thumbnail-tile-pro-video-thumbnail-tile))
797823

798-
Generates a tiled sprite using hte source video frames
824+
Generates a tiled sprite using the source video frames
799825

800826
#### Example
801827

802828
```typescript
803829
pb().videoThumbnailTile({
804-
step: 1, // required
805-
columns: 1, // required
806-
rows: 1, // required
807-
tileWidth: 50, // required
808-
tileHeight: 50, // required
809-
extendTile: true, // optional
810-
trim: true, // optional
811-
fill: true, // optional
812-
focusX: 10.3, // optional
813-
focusY: 10.3, // optional
830+
step: 1, // required
831+
columns: 1, // required
832+
rows: 1, // required
833+
tileWidth: 50, // required
834+
tileHeight: 50, // required
835+
extendTile: true, // optional
836+
trim: true, // optional
837+
fill: true, // optional
838+
focusX: 10.3, // optional
839+
focusY: 10.3, // optional
814840
});
815841
```
816842

@@ -856,8 +882,8 @@ Defines the desired width and height of the watermark. imgproxy always uses `fit
856882

857883
```typescript
858884
pb().watermarkSize({
859-
width: 30, // required
860-
height: 30, // required
885+
width: 30, // required
886+
height: 30 // required
861887
});
862888
```
863889

@@ -868,7 +894,7 @@ Generate an image from the provided text and use it as a watermark.
868894
#### Example
869895

870896
```typescript
871-
pb().watermarkText('my watermark');
897+
pb().watermarkText("my watermark");
872898
```
873899

874900
### watermarkUrl ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#watermark-url-idwatermark-url))
@@ -889,4 +915,4 @@ Multiply the image dimensions according to the specified factors.
889915

890916
```typescript
891917
pb().zoom(3);
892-
```
918+
```

‎docs/assets/highlight.css‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@
1717
--dark-hl-7: #B5CEA8;
1818
--light-hl-8: #0070C1;
1919
--dark-hl-8: #4FC1FF;
20-
--light-hl-9: #000000;
21-
--dark-hl-9: #C8C8C8;
22-
--light-hl-10: #267F99;
23-
--dark-hl-10: #4EC9B0;
2420
--light-code-background: #FFFFFF;
2521
--dark-code-background: #1E1E1E;
2622
}
@@ -35,8 +31,6 @@
3531
--hl-6: var(--light-hl-6);
3632
--hl-7: var(--light-hl-7);
3733
--hl-8: var(--light-hl-8);
38-
--hl-9: var(--light-hl-9);
39-
--hl-10: var(--light-hl-10);
4034
--code-background: var(--light-code-background);
4135
} }
4236

@@ -50,8 +44,6 @@
5044
--hl-6: var(--dark-hl-6);
5145
--hl-7: var(--dark-hl-7);
5246
--hl-8: var(--dark-hl-8);
53-
--hl-9: var(--dark-hl-9);
54-
--hl-10: var(--dark-hl-10);
5547
--code-background: var(--dark-code-background);
5648
} }
5749

@@ -65,8 +57,6 @@
6557
--hl-6: var(--light-hl-6);
6658
--hl-7: var(--light-hl-7);
6759
--hl-8: var(--light-hl-8);
68-
--hl-9: var(--light-hl-9);
69-
--hl-10: var(--light-hl-10);
7060
--code-background: var(--light-code-background);
7161
}
7262

@@ -80,8 +70,6 @@
8070
--hl-6: var(--dark-hl-6);
8171
--hl-7: var(--dark-hl-7);
8272
--hl-8: var(--dark-hl-8);
83-
--hl-9: var(--dark-hl-9);
84-
--hl-10: var(--dark-hl-10);
8573
--code-background: var(--dark-code-background);
8674
}
8775

@@ -94,6 +82,4 @@
9482
.hl-6 { color: var(--hl-6); }
9583
.hl-7 { color: var(--hl-7); }
9684
.hl-8 { color: var(--hl-8); }
97-
.hl-9 { color: var(--hl-9); }
98-
.hl-10 { color: var(--hl-10); }
9985
pre, code { background: var(--code-background); }

0 commit comments

Comments
 (0)