{"id":13520503,"url":"https://github.com/BetaHuhn/readme-fish","last_synced_at":"2025-03-31T16:31:31.564Z","repository":{"id":37956752,"uuid":"394916223","full_name":"BetaHuhn/readme-fish","owner":"BetaHuhn","description":"⚡📝Blazingly fast statically hosted GitHub READMEs","archived":false,"fork":false,"pushed_at":"2022-12-21T17:05:08.000Z","size":345,"stargazers_count":5,"open_issues_count":10,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-02T05:23:49.023Z","etag":null,"topics":["cloudflare-workers","readme","readme-md","readme-viewer","static-site"],"latest_commit_sha":null,"homepage":"https://readme.fish","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BetaHuhn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"ko_fi":"betahuhn","github":"betahuhn"}},"created_at":"2021-08-11T08:19:28.000Z","updated_at":"2023-06-29T15:02:46.000Z","dependencies_parsed_at":"2023-01-30T04:16:18.068Z","dependency_job_id":null,"html_url":"https://github.com/BetaHuhn/readme-fish","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"BetaHuhn/cf-worker-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BetaHuhn%2Freadme-fish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BetaHuhn%2Freadme-fish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BetaHuhn%2Freadme-fish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BetaHuhn%2Freadme-fish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BetaHuhn","download_url":"https://codeload.github.com/BetaHuhn/readme-fish/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222670691,"owners_count":17020513,"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":["cloudflare-workers","readme","readme-md","readme-viewer","static-site"],"created_at":"2024-08-01T05:02:22.700Z","updated_at":"2024-11-02T03:31:39.514Z","avatar_url":"https://github.com/BetaHuhn.png","language":"TypeScript","funding_links":["https://ko-fi.com/betahuhn","https://github.com/sponsors/betahuhn","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=394RTSBEEEFEE","https://ko-fi.com/F1F81S2RK"],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"https://readme-fish.fra1.cdn.digitaloceanspaces.com/static/logoBackground.png\" title=\"ReadMe.fish logo\" alt=\"ReadMe.fish logo\" width=\"128\"\u003e\n  \n# ReadMe.fish\n\n[![Node CI](https://github.com/BetaHuhn/readme-fish/workflows/Node%20CI/badge.svg)](https://github.com/BetaHuhn/readme-fish/actions?query=workflow%3A%22Node+CI%22) [![Release CI](https://github.com/BetaHuhn/readme-fish/workflows/Release%20CI/badge.svg)](https://github.com/BetaHuhn/readme-fish/actions?query=workflow%3A%22Release+CI%22) [![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/BetaHuhn/readme-fish/blob/master/LICENSE) ![David](https://img.shields.io/david/betahuhn/readme-fish)\n\nBlazingly fast statically hosted GitHub READMEs\n\n\u003c/div\u003e\n\n## 👋 Introduction\n\n[ReadMe.fish](https://readme.fish) dynamicly generates a blazingly fast static HTML version of any public GitHub repos README.md file and caches it on a CDN using CloudFlare Workers. Simply go the [homepage](https://readme.fish) and specify the GitHub repo as the path, similar to how a repo is accessed on GitHub e.g. `readme.fish/username/repo`. Try [this](https://readme.fish/betahuhn/betahuhn) repo as an example!\n\n## 📚 Usage\n\n[ReadMe.fish](https://readme.fish) generates a static HTML version of any public GitHub repo and caches it in a fast CDN. This might be useful for a variety of usecases. Maybe you want to quickly view a repos README without the clutter of the GitHub UI. Or you want a fast hosted version of your repos README file/documentation. You could even use it to host your own [mini website](https://readme.fish/betahuhn/betahuhn)!\n\n## 💻 Available commands\n\n- run `yarn lint` or `npm run lint` to run eslint.\n- run `yarn test` or `npm run test` to run all Mocha tests.\n- run `yarn dev` or `npm run dev` to run the Worker locally with [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/commands#dev).\n- run `yarn build` or `npm run build` to produce a production version with webpack.\n\n## ❔ About\n\nThis project was developed by me ([@betahuhn](https://github.com/BetaHuhn)) in my free time. If you want to support me:\n\n[![Donate via PayPal](https://img.shields.io/badge/paypal-donate-009cde.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=394RTSBEEEFEE)\n\n[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F81S2RK)\n\n## 📄 License\n\nCopyright 2021 Maximilian Schiller\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBetaHuhn%2Freadme-fish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBetaHuhn%2Freadme-fish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBetaHuhn%2Freadme-fish/lists"}