Skip to content

Commit c5a4a66

Browse files
authored
Fix links to documentation in README.md (#196)
* fix: Fix links to docs.imgproxy.net * fix: Fix links to docs.imgproxy.net
1 parent 638065a commit c5a4a66

1 file changed

Lines changed: 48 additions & 48 deletions

File tree

README.md

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ end
9494
- **salt** (`IMGPROXY_SALT`) - Hex-encoded signature salt. Default: `nil`.
9595
- **raw_key** (`IMGPROXY_RAW_KEY`) - Raw (not hex-encoded) signature key. Default: `nil`.
9696
- **raw_salt** (`IMGPROXY_RAW_SALT`) - Raw (not hex-encoded) signature salt. Default: `nil`.
97-
- **signature_size** (`IMGPROXY_SIGNATURE_SIZE`) - Signature size. See [URL signature](https://docs.imgproxy.net/#/configuration?id=url-signature) section of imgproxy docs. Default: 32.
97+
- **signature_size** (`IMGPROXY_SIGNATURE_SIZE`) - Signature size. See [URL signature](https://docs.imgproxy.net/configuration?id=url-signature) section of imgproxy docs. Default: 32.
9898
- **use_short_options** (`IMGPROXY_USE_SHORT_OPTIONS`) - Use short processing options names (`rs` for `resize`, `g` for `gravity`, etc). Default: true.
9999
- **base64_encode_urls** (`IMGPROXY_BASE64_ENCODE_URLS`) - Encode source URLs to base64. Default: false.
100100
- **always_escape_plain_urls** (`IMGPROXY_ALWAYS_ESCAPE_PLAIN_URLS`) - Always escape plain source URLs even when ones don't need to be escaped. Default: false.
@@ -194,51 +194,51 @@ builder.url_for("http://images.example.com/images/image2.jpg")
194194

195195
### Supported imgproxy processing options
196196

197-
- [resize](https://docs.imgproxy.net/#/generating_the_url_advanced?id=resize)
198-
- [size](https://docs.imgproxy.net/#/generating_the_url_advanced?id=size)
199-
- [resizing_type](https://docs.imgproxy.net/#/generating_the_url_advanced?id=resizing-type)
200-
- [resizing_algorithm](https://docs.imgproxy.net/#/generating_the_url_advanced?id=resizing-algorithm) _(pro)_
201-
- [width](https://docs.imgproxy.net/#/generating_the_url_advanced?id=width)
202-
- [height](https://docs.imgproxy.net/#/generating_the_url_advanced?id=height)
203-
- [dpr](https://docs.imgproxy.net/#/generating_the_url_advanced?id=dpr)
204-
- [enlarge](https://docs.imgproxy.net/#/generating_the_url_advanced?id=enlarge)
205-
- [extend](https://docs.imgproxy.net/#/generating_the_url_advanced?id=extend)
206-
- [gravity](https://docs.imgproxy.net/#/generating_the_url_advanced?id=gravity)
207-
- [crop](https://docs.imgproxy.net/#/generating_the_url_advanced?id=crop)
208-
- [padding](https://docs.imgproxy.net/#/generating_the_url_advanced?id=padding)
209-
- [trim](https://docs.imgproxy.net/#/generating_the_url_advanced?id=trim)
210-
- [rotate](https://docs.imgproxy.net/#/generating_the_url_advanced?id=rotate)
211-
- [quality](https://docs.imgproxy.net/#/generating_the_url_advanced?id=quality)
212-
- [max_bytes](https://docs.imgproxy.net/#/generating_the_url_advanced?id=max-bytes)
213-
- [background](https://docs.imgproxy.net/#/generating_the_url_advanced?id=background)
214-
- [background_alpha](https://docs.imgproxy.net/#/generating_the_url_advanced?id=background-alpha) _(pro)_
215-
- [adjust](https://docs.imgproxy.net/#/generating_the_url_advanced?id=adjust) _(pro)_
216-
- [brightness](https://docs.imgproxy.net/#/generating_the_url_advanced?id=brightness) _(pro)_
217-
- [contrast](https://docs.imgproxy.net/#/generating_the_url_advanced?id=contrast) _(pro)_
218-
- [saturation](https://docs.imgproxy.net/#/generating_the_url_advanced?id=saturation) _(pro)_
219-
- [blur](https://docs.imgproxy.net/#/generating_the_url_advanced?id=blur)
220-
- [sharpen](https://docs.imgproxy.net/#/generating_the_url_advanced?id=sharpen)
221-
- [pixelate](https://docs.imgproxy.net/#/generating_the_url_advanced?id=pixelate) _(pro)_
222-
- [unsharpening](https://docs.imgproxy.net/#/generating_the_url_advanced?id=unsharpening) _(pro)_
223-
- [watermark](https://docs.imgproxy.net/#/generating_the_url_advanced?id=watermark)
224-
- [watermark_url](https://docs.imgproxy.net/#/generating_the_url_advanced?id=watermark-url) _(pro)_
225-
- [style](https://docs.imgproxy.net/#/generating_the_url_advanced?id=style) _(pro)_
226-
- [jpeg_options](https://docs.imgproxy.net/#/generating_the_url_advanced?id=jpeg-options) _(pro)_
227-
- [png_options](https://docs.imgproxy.net/#/generating_the_url_advanced?id=png-options) _(pro)_
228-
- [gif_options](https://docs.imgproxy.net/#/generating_the_url_advanced?id=gif-options) _(pro)_
229-
- [page](https://docs.imgproxy.net/#/generating_the_url_advanced?id=page) _(pro)_
230-
- [video_thumbnail_second](https://docs.imgproxy.net/#/generating_the_url_advanced?id=video-thumbnail-second) _(pro)_
231-
- [preset](https://docs.imgproxy.net/#/generating_the_url_advanced?id=preset)
232-
- [cachebuster](https://docs.imgproxy.net/#/generating_the_url_advanced?id=cachebuster)
233-
- [strip_metadata](https://docs.imgproxy.net/#/generating_the_url_advanced?id=strip-metadata)
234-
- [strip_color_profile](https://docs.imgproxy.net/#/generating_the_url_advanced?id=strip-color-profile)
235-
- [auto_rotate](https://docs.imgproxy.net/#/generating_the_url_advanced?id=auto-rotate)
236-
- [filename](https://docs.imgproxy.net/#/generating_the_url_advanced?id=filename)
237-
- [format](https://docs.imgproxy.net/#/generating_the_url_advanced?id=format)
238-
- [return_attachment](https://docs.imgproxy.net/#/generating_the_url_advanced?id=return-attachment)
239-
- [expires](https://docs.imgproxy.net/#/generating_the_url?id=expires)
240-
241-
_See [imgproxy URL format guide](https://docs.imgproxy.net/#/generating_the_url_advanced?id=processing-options) for more info._
197+
- [resize](https://docs.imgproxy.net/generating_the_url?id=resize)
198+
- [size](https://docs.imgproxy.net/generating_the_url?id=size)
199+
- [resizing_type](https://docs.imgproxy.net/generating_the_url?id=resizing-type)
200+
- [resizing_algorithm](https://docs.imgproxy.net/generating_the_url?id=resizing-algorithm) _(pro)_
201+
- [width](https://docs.imgproxy.net/generating_the_url?id=width)
202+
- [height](https://docs.imgproxy.net/generating_the_url?id=height)
203+
- [dpr](https://docs.imgproxy.net/generating_the_url?id=dpr)
204+
- [enlarge](https://docs.imgproxy.net/generating_the_url?id=enlarge)
205+
- [extend](https://docs.imgproxy.net/generating_the_url?id=extend)
206+
- [gravity](https://docs.imgproxy.net/generating_the_url?id=gravity)
207+
- [crop](https://docs.imgproxy.net/generating_the_url?id=crop)
208+
- [padding](https://docs.imgproxy.net/generating_the_url?id=padding)
209+
- [trim](https://docs.imgproxy.net/generating_the_url?id=trim)
210+
- [rotate](https://docs.imgproxy.net/generating_the_url?id=rotate)
211+
- [quality](https://docs.imgproxy.net/generating_the_url?id=quality)
212+
- [max_bytes](https://docs.imgproxy.net/generating_the_url?id=max-bytes)
213+
- [background](https://docs.imgproxy.net/generating_the_url?id=background)
214+
- [background_alpha](https://docs.imgproxy.net/generating_the_url?id=background-alpha) _(pro)_
215+
- [adjust](https://docs.imgproxy.net/generating_the_url?id=adjust) _(pro)_
216+
- [brightness](https://docs.imgproxy.net/generating_the_url?id=brightness) _(pro)_
217+
- [contrast](https://docs.imgproxy.net/generating_the_url?id=contrast) _(pro)_
218+
- [saturation](https://docs.imgproxy.net/generating_the_url?id=saturation) _(pro)_
219+
- [blur](https://docs.imgproxy.net/generating_the_url?id=blur)
220+
- [sharpen](https://docs.imgproxy.net/generating_the_url?id=sharpen)
221+
- [pixelate](https://docs.imgproxy.net/generating_the_url?id=pixelate) _(pro)_
222+
- [unsharpening](https://docs.imgproxy.net/generating_the_url?id=unsharpening) _(pro)_
223+
- [watermark](https://docs.imgproxy.net/generating_the_url?id=watermark)
224+
- [watermark_url](https://docs.imgproxy.net/generating_the_url?id=watermark-url) _(pro)_
225+
- [style](https://docs.imgproxy.net/generating_the_url?id=style) _(pro)_
226+
- [jpeg_options](https://docs.imgproxy.net/generating_the_url?id=jpeg-options) _(pro)_
227+
- [png_options](https://docs.imgproxy.net/generating_the_url?id=png-options) _(pro)_
228+
- [gif_options](https://docs.imgproxy.net/generating_the_url?id=gif-options) _(pro)_
229+
- [page](https://docs.imgproxy.net/generating_the_url?id=page) _(pro)_
230+
- [video_thumbnail_second](https://docs.imgproxy.net/generating_the_url?id=video-thumbnail-second) _(pro)_
231+
- [preset](https://docs.imgproxy.net/generating_the_url?id=preset)
232+
- [cachebuster](https://docs.imgproxy.net/generating_the_url?id=cachebuster)
233+
- [strip_metadata](https://docs.imgproxy.net/generating_the_url?id=strip-metadata)
234+
- [strip_color_profile](https://docs.imgproxy.net/generating_the_url?id=strip-color-profile)
235+
- [auto_rotate](https://docs.imgproxy.net/generating_the_url?id=auto-rotate)
236+
- [filename](https://docs.imgproxy.net/generating_the_url?id=filename)
237+
- [format](https://docs.imgproxy.net/generating_the_url?id=format)
238+
- [return_attachment](https://docs.imgproxy.net/generating_the_url?id=return-attachment)
239+
- [expires](https://docs.imgproxy.net/generating_the_url?id=expires)
240+
241+
_See [imgproxy URL format guide](https://docs.imgproxy.net/generating_the_url?id=processing-options) for more info._
242242

243243
### Complex processing options
244244

@@ -264,7 +264,7 @@ Imgproxy.url_for(
264264
# => .../c:500:600:nowe:10:5/...
265265
```
266266

267-
All the arguments have the same names as in [imgproxy documentation](https://docs.imgproxy.net/#/generating_the_url_advanced?id=processing-options).
267+
All the arguments have the same names as in [imgproxy documentation](https://docs.imgproxy.net/generating_the_url?id=processing-options).
268268

269269
You can use named arguments even if the processing option is not supported by the gem. In this case the arguments won't be reordered nor formatted, so you should provide them in the same order and right the same way they should appear in the URL:
270270

@@ -331,7 +331,7 @@ Imgproxy.url_for(
331331

332332
## Getting the image info
333333

334-
If you're a happy user of imgproxy Pro, you may find useful it's [Getting the image info](https://docs.imgproxy.net/#/getting_the_image_info) feature. imgproxy.rb allows you to easily generate info URLs for your images:
334+
If you're a happy user of imgproxy Pro, you may find useful it's [Getting the image info](https://docs.imgproxy.net/getting_the_image_info) feature. imgproxy.rb allows you to easily generate info URLs for your images:
335335

336336
```ruby
337337
# Framework-agnositic way

0 commit comments

Comments
 (0)