{"id":13826152,"url":"https://github.com/PabloLec/website-to-gif","last_synced_at":"2025-07-09T00:32:40.179Z","repository":{"id":38234909,"uuid":"384422611","full_name":"PabloLec/website-to-gif","owner":"PabloLec","description":"GitHub Action to turn your website into a GIF :camera:","archived":false,"fork":false,"pushed_at":"2024-11-13T01:11:44.000Z","size":282618,"stargazers_count":112,"open_issues_count":3,"forks_count":15,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-13T06:11:48.806Z","etag":null,"topics":["actions","automation","documentation-generator","documentation-tool","ducumentation","generator","gif","gif-animation","gif-creator","github-actions","image","image-generation","image-generator","publication","readme","readme-generator","selenium","selenium-python","selenium-webdriver","webp"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PabloLec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-09T11:56:59.000Z","updated_at":"2024-10-25T04:08:22.000Z","dependencies_parsed_at":"2023-10-16T17:17:41.746Z","dependency_job_id":"1a2f4a3f-f266-44d9-921e-8e3f7ce694df","html_url":"https://github.com/PabloLec/website-to-gif","commit_stats":{"total_commits":181,"total_committers":5,"mean_commits":36.2,"dds":0.6243093922651934,"last_synced_commit":"44056271a60cc6748fdfc990633a51bcb124a2cb"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PabloLec%2Fwebsite-to-gif","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PabloLec%2Fwebsite-to-gif/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PabloLec%2Fwebsite-to-gif/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PabloLec%2Fwebsite-to-gif/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PabloLec","download_url":"https://codeload.github.com/PabloLec/website-to-gif/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225476384,"owners_count":17480215,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","automation","documentation-generator","documentation-tool","ducumentation","generator","gif","gif-animation","gif-creator","github-actions","image","image-generation","image-generator","publication","readme","readme-generator","selenium","selenium-python","selenium-webdriver","webp"],"created_at":"2024-08-04T09:01:32.922Z","updated_at":"2024-11-20T05:30:24.124Z","avatar_url":"https://github.com/PabloLec.png","language":"Python","funding_links":[],"categories":["Python","Recently Updated","Community Resources"],"sub_categories":["[Sep 02, 2024](/content/2024/09/02/README.md)","Utility"],"readme":"# website-to-gif [![GitHub release (latest by date)](https://img.shields.io/github/v/release/pablolec/website-to-gif)](https://github.com/PabloLec/website-to-gif/releases/) [![GitHub](https://img.shields.io/github/license/pablolec/website-to-gif)](https://github.com/PabloLec/website-to-gif/blob/main/LICENSE)\n\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"docs/images/ss_15_tps_80.gif\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003cb\u003eThis Github Action automatically creates a animated GIF or WebP from a given web page to display on your project README (or anywhere else).\u003c/b\u003e\n\u003c/p\u003e\n\n## Usage\n\n\nIn your GitHub repo, create a workflow file or extend an existing one. (e.g. `.github/workflows/gif.yml`)\n\nYou have to also include a step to `checkout` and commit to the repo.\nYou can use the following example `gif.yml`. Make sure to modify the `url` value and add any other [input](#Inputs) you want to use.\n\n`.github/workflows/gif.yml`\n``` yaml\nname: Generate demo file\n\non: push\n\njobs:\n  generate-gif:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - name: Website to file\n        uses: PabloLec/website-to-gif@2.1.5\n        with:\n          url: \"https://docs.github.com/en/get-started\"\n      - name: Commit file to GH repo\n        run: |\n          git config --global user.name \"PabloLec/website-to-gif\"\n          git config --global user.email \"action@github.com\"\n          git add .\n          git commit -m 'Update file'\n          git push\n```\n\nSee [official GitHub doc](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions) to further customize your workflow.\n\n## Inputs\n\n| Name                 | Description                                                                                                                   | Default         | Example                          |\n|----------------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------|----------------------------------|\n| url                  | Web page URL to be captured. **Required**                                                                                                   |                 | `url: \"https://docs.github.com\"` |\n| save_path            | File saving path, starts with `/`. Make sure the path you provide already exists as this action will not create any directory. | repo root       | `save_path: \"/docs/images/\"`     |\n| file_format          | Output file format, currently support GIF and WebP                                                                             | GIF             | `file_format: \"WebP\"`            |\n| file_name            | File name, **do not include extension or path**                                                                                | demo            | `file_name: \"ss_25_tps_100\"`     |\n| window_width         | Browser window width                                                                                                          | 1920 (px)       | `window_width: 1366`             |\n| window_height        | Browser window height                                                                                                         | 1080 (px)       | `window_height: 768`             |\n| stop_y               | Position where file capture should stop                                                                                       | bottom of page  | `stop_y: 800`                    |\n| start_y              | Position where file capture should start                                                                                      | 0 (px)          | `start_y: 1024`                  |\n| final_width          | Final file width                                                                                                              | 640 (px)        | `final_width: 1024`              |\n| final_height         | Final file height                                                                                                             | 360 (px)        | `final_height: 576`              |\n| scroll_step          | Number of pixels by scroll                                                                                                    | 25 (px)         | `scroll_step: 50`                |\n| time_per_frame       | Milliseconds per frame                                                                                                        | 100 (ms)        | `time_per_frame: 200`            |\n| start_delay          | Number of milliseconds to wait for before starting capture                                                                    | 0 (ms)          | `start_delay: 100`               |\n| no_scoll             | Capture GIF without page scroll, will discard any scroll related parameter                                                    | false           | `no_scoll: true`                 |\n| time_between_frames  | Number of milliseconds between frame captures if no_scroll is true                                                            | 100 (ms)        | `time_between_frames: 200`       |\n| number_of_frames     | Number of frames to be captured if no_scroll is true                                                                           | 20              | `number_of_frames: 50`           |\n| resizing_filter      | Filter used to resize frames, see https://pillow.readthedocs.io/en/stable/reference/Image.html?highlight=resize#PIL.Image.Image.resize | LANCZOS         | `resizing_filter: \"LANCZOS\"`     |\n\n## Examples\n\nIncrease or decrease `scroll_step` and `time_per_frame` to modify file rendering and filesize.\n\n#### `scroll_step: 15` `time_per_frame: 80`\n![](/docs/images/ss_15_tps_80.gif)\n#### `scroll_step: 25` `time_per_frame: 100`\n![](/docs/images/ss_25_tps_100.gif)\n#### `scroll_step: 50` `time_per_frame: 50`\n![](/docs/images/ss_50_tps_50.gif)\n#### `scroll_step: 50` `time_per_frame: 100`\n![](/docs/images/ss_50_tps_100.gif)\n#### `scroll_step: 50` `time_per_frame: 200`\n![](/docs/images/ss_50_tps_200.gif)\n\nYou can also capture pages without scrolling\n\n#### `no_scoll: true` `time_per_frame: 100` `time_between_frames: 100` `number_of_frames: 50`\n![](/docs/images/animated_no_scroll.gif)\n\n## WebP\n\nWebP rendering will take **a lot** of time to benefit from lossless quality and file size optimization.\n\n## Contributing\n\nFeel free to contribute!\nTo suggest a new feature, report a bug or offer your help, simply open a new [issue](https://github.com/PabloLec/website-to-gif/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPabloLec%2Fwebsite-to-gif","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPabloLec%2Fwebsite-to-gif","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPabloLec%2Fwebsite-to-gif/lists"}