Skip to content

Commit

Permalink
Add tachyon limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
mikelittle committed Sep 5, 2024
1 parent c14a7e6 commit 98a35d6
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/dynamic-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,12 @@ The following query string arguments can be applied to any image delivered by Ta
|`webp`|Boolean, 1|Force WebP format.|
|`lb`|String, "w,h"|Add letterboxing effect to images, by scaling them to width, height while maintaining the aspect ratio and filling the rest with black or `background`.|
|`background`|String|Add background color via name (red) or hex value (%23ff0000). Don't forget to escape # as `%23`.|

## Limitations

Image files that contain dimensions as part of the file name, e.g.
`my-image-100x200.png` can cause issues for Tachyon. We recommend you rename all
images to remove dimensions from their file names, as well as any other special
characters. You can
use [this tool](https://github.com/humanmade/rename-images-command) as a
framework to convert file names.

0 comments on commit 98a35d6

Please sign in to comment.