Browse Source

Update docs and changelog

DarthSim 1 năm trước cách đây
mục cha
commit
f87ce66519
2 tập tin đã thay đổi với 18 bổ sung2 xóa
  1. 1 0
      CHANGELOG.md
  2. 17 2
      docs/generating_the_url.md

+ 1 - 0
CHANGELOG.md

@@ -5,6 +5,7 @@
 - Add [multi-region mode](https://docs.imgproxy.net/latest/serving_files_from_s3?id=multi-region-mode) to S3 integration.
 - Add the ability to [load environment variables](https://docs.imgproxy.net/latest/loading_environment_variables) from a file or a cloud secret.
 - Add `IMGPROXY_WORKERS` alias for the `IMGPROXY_CONCURRENCY` config.
+- (pro) Add [pages](https://docs.imgproxy.net/latest/generating_the_url?id=pages) processing option.
 
 ### Change
 - Don't report `The image request is cancelled` errors.

+ 17 - 2
docs/generating_the_url.md

@@ -683,10 +683,25 @@ page:%page
 pg:%page
 ```
 
-When a source image supports pagination (PDF, TIFF) or animation (GIF, WebP), this option allows specifying the page to use it on. Page numeration starts from zero.
+When a source image supports pagination (PDF, TIFF) or animation (GIF, WebP), this option allows specifying the page to use. Page numeration starts from zero.
+
+**📝 Note:** If both the source and the resulting image formats supoprt animation, imgproxy will ignore this option and use all the source image pages. Use the [disable_animation](#disable-animation) option to make imgproxy treat all images as not animated.
 
 Default: 0
 
+### Pages![pro](./assets/pro.svg) :id=pages
+
+```
+pages:%pages
+pgs:%pages
+```
+
+When a source image supports pagination (PDF, TIFF) or animation (GIF, WebP), this option allows specifying the number of pages to use. The pages will be stacked vertically and left-aligned.
+
+**📝 Note:** If both the source and the resulting image formats supoprt animation, imgproxy will ignore this option and use all the source image pages. Use the [disable_animation](#disable-animation) option to make imgproxy treat all images as not animated.
+
+Default: 1
+
 ### Disable animation![pro](./assets/pro.svg) :id=disable-animation
 
 ```
@@ -694,7 +709,7 @@ disable_animation:%disable
 da:%disable
 ```
 
-When set to `1`, `t` or `true`, imgproxy will use a single frame of animated images. Use the [page](#page) option to specify which frame imgproxy should use.
+When set to `1`, `t` or `true`, imgproxy will treat all images as not animated. Use the [page](#page) and the [pages](#pages) options to specify which frames imgproxy should use.
 
 Default: `false`