Website to GIF
A GitHub Action that captures a webpage and converts it into an animated GIF or WebP file.
What is Website to GIF?
website-to-gif is a GitHub Action that converts webpages into animated GIFs or WebP files. It automates the process of capturing screenshots while scrolling or at timed intervals, then stitches them together into a single animated file. This solves the problem of manually creating visual demos or documentation assets for projects.
Developers and technical writers who need to generate animated previews of web applications for README files, documentation, or marketing materials directly within their GitHub workflows.
Developers choose website-to-gif because it integrates natively with GitHub Actions, requires no external services, and offers fine-grained control over the capture process. Its open-source nature and configurability make it a flexible alternative to manual or paid screenshot-to-video tools.
Overview
GitHub Action to turn your website into a GIF :camera:
Use Cases
Best For
- Creating animated demos for GitHub README files
- Automatically generating visual changelogs for web applications
- Producing documentation assets that show UI interactions
- Building visual regression testing pipelines
- Generating promotional GIFs for open-source projects
- Capturing webpage states for bug reports or tutorials
Not Ideal For
- Projects requiring real-time video output or MP4 format compatibility
- Teams using CI/CD systems other than GitHub Actions
- Websites with heavy JavaScript interactions that need precise event-based capture
Pros & Cons
Pros
Captures sequential frames through scrolling or timed intervals, with configurable parameters like scroll_step and time_per_frame, enabling hands-free demo generation.
Supports both GIF and WebP formats, allowing optimization for file size and quality, though the README notes WebP can be slow for lossless rendering.
Includes a ready-to-use workflow example for automatic generation and commit, making it easy to embed in existing GitHub repositories without external tools.
Offers numerous inputs like window size, scroll steps, and resizing filters, providing fine-grained control over the capture process and output appearance.
Cons
The README explicitly warns that WebP rendering takes 'a lot' of time for lossless quality, which can slow down CI/CD pipelines and increase resource usage.
Only outputs GIF and WebP, lacking support for more common video formats like MP4 that are often preferred for compatibility and compression in modern applications.
Requires the save_path to exist beforehand, as the action won't create directories, adding setup overhead and potential for errors in workflow configuration.
Frequently Asked Questions
Related Projects
action-tmateDebug your GitHub Actions via SSH by using tmate to get access to the runner system itself.
Paths FilterConditionally run actions based on files modified by PR, feature branch or pushed commits
Setup ssh-agentGitHub Action to setup `ssh-agent` with a private key
GitHub Actions to compile LaTeX documents:octocat: GitHub Action to compile LaTeX documents
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.