https://github.com/BetaHuhn/readme-fish

⚡📝Blazingly fast statically hosted GitHub READMEs
https://github.com/BetaHuhn/readme-fish

cloudflare-workers readme readme-md readme-viewer static-site

Last synced: 4 months ago
JSON representation

⚡📝Blazingly fast statically hosted GitHub READMEs

• Host: GitHub
• URL: https://github.com/BetaHuhn/readme-fish
• Owner: BetaHuhn
• License: mit
• Created: 2021-08-11T08:19:28.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-21T17:05:08.000Z (about 2 years ago)
• Last Synced: 2024-08-02T05:23:49.023Z (7 months ago)
• Topics: cloudflare-workers, readme, readme-md, readme-viewer, static-site
• Language: TypeScript
• Homepage: https://readme.fish
• Size: 337 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - readme-fish - ⚡📝Blazingly fast statically hosted GitHub READMEs (TypeScript)

README

        




  

# ReadMe.fish

[![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)

Blazingly fast statically hosted GitHub READMEs



## 👋 Introduction

[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!

## 📚 Usage

[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)!

## 💻 Available commands

- run `yarn lint` or `npm run lint` to run eslint.

- run `yarn test` or `npm run test` to run all Mocha tests.

- run `yarn dev` or `npm run dev` to run the Worker locally with [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/commands#dev).

- run `yarn build` or `npm run build` to produce a production version with webpack.

## ❔ About

This project was developed by me ([@betahuhn](https://github.com/BetaHuhn)) in my free time. If you want to support me:

[![Donate via PayPal](https://img.shields.io/badge/paypal-donate-009cde.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=394RTSBEEEFEE)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F81S2RK)

## 📄 License

Copyright 2021 Maximilian Schiller

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.