From c2ac0a6827ebf18cdf20637ad63acc6ecc131a0c Mon Sep 17 00:00:00 2001 From: DarthSim Date: Tue, 1 Sep 2020 19:57:44 +0600 Subject: [PATCH] Better image formats support docs --- docs/assets/style.css | 2 ++ docs/generating_the_url_advanced.md | 6 +----- docs/generating_the_url_basic.md | 6 +----- docs/image_formats_support.md | 25 ++++++++++++++----------- 4 files changed, 18 insertions(+), 21 deletions(-) diff --git a/docs/assets/style.css b/docs/assets/style.css index 076d797f..8781847a 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -24,6 +24,8 @@ --sidebar-border-color: hsla(0,0%,100%,.4); --copycode-background: var(--link-color); + + --table-row-even-background: var(--base-background-color); } .app-name-link img { diff --git a/docs/generating_the_url_advanced.md b/docs/generating_the_url_advanced.md index 1715c3bb..925e76bc 100644 --- a/docs/generating_the_url_advanced.md +++ b/docs/generating_the_url_advanced.md @@ -538,11 +538,7 @@ When using encoded source URL, you can specify the [extension](#extension) after ### Extension -Extension specifies the format of the resulting image. At the moment, imgproxy supports only `jpg`, `png`, `webp`, `gif`, `ico`, and `tiff`, them being the most popular and useful image formats. - -pro Also you can use `mp4` extension to convert animated images to MP4. - -**📝Note:** Read more about image formats support [here](image_formats_support.md). +Extension specifies the format of the resulting image. Read about image formats support [here](image_formats_support.md). The extension part can be omitted. In this case, imgproxy will use source image format as resulting one. If source image format is not supported as resulting, imgproxy will use `jpg`. You also can [enable WebP support detection](configuration.md#webp-support-detection) to use it as default resulting format when possible. diff --git a/docs/generating_the_url_basic.md b/docs/generating_the_url_basic.md index 5fef6582..def1001c 100644 --- a/docs/generating_the_url_basic.md +++ b/docs/generating_the_url_basic.md @@ -87,11 +87,7 @@ When using encoded source URL, you can specify the [extension](#extension) after ### Extension -Extension specifies the format of the resulting image. At the moment, imgproxy supports only `jpg`, `png`, `webp`, `gif`, `ico`, and `tiff`, them being the most popular and useful image formats. - -pro Also you can use `mp4` extension to convert animated images to MP4. - -**📝Note:** Read more about image formats support [here](image_formats_support.md). +Extension specifies the format of the resulting image. Read about image formats support [here](image_formats_support.md). The extension part can be omitted. In this case, imgproxy will use source image format as resulting one. If source image format is not supported as resulting, imgproxy will use `jpg`. You also can [enable WebP support detection](configuration.md#webp-support-detection) to use it as default resulting format when possible. diff --git a/docs/image_formats_support.md b/docs/image_formats_support.md index 796fecc4..ce7f8d53 100644 --- a/docs/image_formats_support.md +++ b/docs/image_formats_support.md @@ -2,17 +2,20 @@ At the moment, imgproxy supports only the most popular image formats: -* PNG; -* JPEG; -* WebP; -* GIF; -* ICO; -* SVG; -* MP4 pro; -* HEIC _(source only)_; -* BMP; -* TIFF; -* PDF _(source only)_ pro. +| Format | Extension | Source | Result | +| -------|-----------|--------|--------| +| PNG | `png` | Yes | Yes | +| JPEG | `jpg` | Yes | Yes | +| WebP | `webp` | Yes | Yes | +| GIF | `gif` | Yes | Yes | +| ICO | `ico` | Yes | Yes | +| SVG | `svg` | Yes | [See notes](#svg-support) | +| HEIC | `heic` | Yes | No | +| BMP | `bmp` | Yes | Yes | +| TIFF | `tiff` | Yes | Yes | +| PDF pro | `pdf` | Yes | No | +| MP4 (h264) pro | `mp4` | [See notes](#video-thumbnails-) | Yes | +| Other video formats pro | | [See notes](#video-thumbnails-) | No | ## GIF support