Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add tachyon limitations #389

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Add tachyon limitations #389

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/dynamic-images.md
View file
Open in desktop
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.