{"id":15286356,"url":"https://github.com/cherninlab/breek","last_synced_at":"2026-02-16T13:05:17.380Z","repository":{"id":255752818,"uuid":"851771746","full_name":"cherninlab/breek","owner":"cherninlab","description":"🕹️ Generate a breakout animation from a GitHub user's contribution graph.","archived":false,"fork":false,"pushed_at":"2024-11-17T23:22:27.000Z","size":1520,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T03:54:18.406Z","etag":null,"topics":["gif","github-actions","github-contribution-graph","github-contributions","github-profile-readme","svg-animations"],"latest_commit_sha":null,"homepage":"https://cherninlab.github.io/breek/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cherninlab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2024-09-03T17:17:29.000Z","updated_at":"2024-11-17T23:22:31.000Z","dependencies_parsed_at":"2025-04-13T03:10:00.711Z","dependency_job_id":"088b828f-9574-44f4-9a3d-d4fe7f2f69e9","html_url":"https://github.com/cherninlab/breek","commit_stats":null,"previous_names":["cherninlab/breek"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/cherninlab/breek","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cherninlab%2Fbreek","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cherninlab%2Fbreek/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cherninlab%2Fbreek/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cherninlab%2Fbreek/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cherninlab","download_url":"https://codeload.github.com/cherninlab/breek/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cherninlab%2Fbreek/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278965438,"owners_count":26076899,"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","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["gif","github-actions","github-contribution-graph","github-contributions","github-profile-readme","svg-animations"],"created_at":"2024-09-30T15:13:28.413Z","updated_at":"2025-10-08T15:14:56.116Z","avatar_url":"https://github.com/cherninlab.png","language":"TypeScript","readme":"# 🕹️ breek\n\n[![GitHub release](https://img.shields.io/github/release/cherninlab/breek.svg?style=flat-square)](https://github.com/cherninlab/breek/releases/latest)\n[![GitHub marketplace](https://img.shields.io/badge/marketplace-breek-blue?logo=github\u0026style=flat-square)](https://github.com/marketplace/actions/generate-breakout-game-from-github-contribution-grid)\n![type definitions](https://img.shields.io/npm/types/typescript?style=flat-square)\n\nBreak your GitHub contribution graph.\n\n\u003cpicture\u003e\n  \u003csource\n    media=\"(prefers-color-scheme: dark)\"\n    srcset=\"https://raw.githubusercontent.com/cherninlab/cherninlab/output/github-contribution-grid-breek-dark.svg\"\n  /\u003e\n  \u003csource\n    media=\"(prefers-color-scheme: light)\"\n    srcset=\"https://raw.githubusercontent.com/cherninlab/cherninlab/output/github-contribution-grid-breek.svg\"\n  /\u003e\n  \u003cimg\n    alt=\"github contribution grid breek animation\"\n    src=\"https://raw.githubusercontent.com/cherninlab/breek/output/github-contribution-grid-breek.svg\"\n  /\u003e\n\u003c/picture\u003e\n\nGenerate a breakout animation from a GitHub user's contribution graph.\n\n## Usage\n\n### GitHub Action\n\nUse this action in your workflow:\n\n```yaml\n- name: Generate Breek Animation\n  uses: cherninlab/breek@v1.0.0\n  with:\n    github_user_name: ${{ github.repository_owner }}\n    svg_out_path: dist/github-contribution-grid-breek.svg\n    svg_dark_out_path: dist/github-contribution-grid-breek-dark.svg\n```\n\nThen embed the generated image in your README using the `\u003cpicture\u003e` tag for dark mode support:\n\n```html\n\u003cpicture\u003e\n  \u003csource\n    media=\"(prefers-color-scheme: dark)\"\n    srcset=\"\n      https://raw.githubusercontent.com/\u003cUsername\u003e/\u003cRepository\u003e/output/github-contribution-grid-breek-dark.svg\n    \"\n  /\u003e\n  \u003csource\n    media=\"(prefers-color-scheme: light)\"\n    srcset=\"\n      https://raw.githubusercontent.com/\u003cUsername\u003e/\u003cRepository\u003e/output/github-contribution-grid-breek.svg\n    \"\n  /\u003e\n  \u003cimg\n    alt=\"github contribution grid breek animation\"\n    src=\"https://raw.githubusercontent.com/\u003cUsername\u003e/\u003cRepository\u003e/output/github-contribution-grid-breek.svg\"\n  /\u003e\n\u003c/picture\u003e\n```\n\nReplace `\u003cUsername\u003e` and `\u003cRepository\u003e` with your GitHub username and repository name respectively.\n\ne.g. [demo workflow action](https://github.com/cherninlab/cherninlab/blob/main/.github/workflows/main.yml)\n\n### Interactive Demo\n\n[cherninlab.github.io/breek](https://cherninlab.github.io/breek/)\n\n### Local Development\n\n```\nbun install\nbun run dev\n```\n\nThen open `http://localhost:5173` in your browser.\n\n## Roadmap\n\n- [ ] Create an npx tool for local generation\n- [ ] Add more customization options\n\n## Credits\n\nInspired by [Platane/snk](https://github.com/Platane/snk)\n\n## License\n\nMIT © [Cherninlab](https://github.com/Cherninlab)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcherninlab%2Fbreek","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcherninlab%2Fbreek","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcherninlab%2Fbreek/lists"}