Skymage Documentation
Skymage is a powerful image transformation service that allows you to resize, crop, optimize, and apply effects to your images on-the-fly using simple URL parameters.
Getting Started
Skymage provides a straightforward way to transform images through URL parameters. This approach eliminates the need for server-side image processing code, making your applications lighter and more efficient.
Basic Concept
The basic pattern for a Skymage URL is:
https://[your-handle].skymage.net/v1/[your-domain]/images/[image-path]?[transformations]
For example:
https://demo.skymage.net/v1/daudau.cc/images/sample.jpg?w=300&h=200&fit=cover
This URL will fetch the image at sample.jpg
, resize it to 300×200 pixels using the "cover" fit mode.
Key Features
- On-the-fly transformations: No pre-processing needed
- Simple URL API: Control image transformations with URL parameters
- Highly optimized: Delivers optimized images for faster loading times
- Multiple formats: Support for JPEG, PNG, WebP, AVIF and more
- CDN integration: Works seamlessly with CDNs for global distribution
- Secure: Protect your images with signed URLs
Core Transformation Options
Skymage offers various transformation options to modify your images:
Dimensions and Sizing
Width & Height: Specify dimensions with
w
andh
parametershttps://demo.skymage.net/v1/daudau.cc/images/sample.jpg?w=400&h=300
Fit Modes: Control how images fit within dimensions with
fit
parameterhttps://demo.skymage.net/v1/daudau.cc/images/sample.jpg?w=400&h=300&fit=contain
Cropping: Focus on specific areas with
crop
andp
parametershttps://demo.skymage.net/v1/daudau.cc/images/sample.jpg?w=400&h=300&fit=crop&p=face
Visual Effects
Filters: Apply predefined filters with
filt
parameterhttps://demo.skymage.net/v1/daudau.cc/images/sample.jpg?filt=grayscale
Blur: Add blur effect with
blur
parameterhttps://demo.skymage.net/v1/daudau.cc/images/sample.jpg?blur=10
Sharpen: Enhance image details with
sharpen
parameterhttps://demo.skymage.net/v1/daudau.cc/images/sample.jpg?sharpen=10
Quality
- Quality: Control compression with
q
parameterhttps://demo.skymage.net/v1/daudau.cc/images/sample.jpg?q=80
Integration Examples
Skymage can be integrated into various web platforms:
HTML Integration
<img src="https://demo.skymage.net/v1/daudau.cc/images/sample.jpg?w=400" alt="Sample Image">
CSS Background
.hero {
background-image: url('https://demo.skymage.net/v1/daudau.cc/images/sample.jpg?w=1200&h=600&fit=cover');
}
JavaScript Dynamic Sizing
const width = window.innerWidth > 800 ? 1200 : 600;
const imageUrl = `https://demo.skymage.net/v1/daudau.cc/images/sample.jpg?w=${width}`;
document.getElementById('hero-img').src = imageUrl;