komodokode / readme-jokes

Jokes for your GitHub READMEs

README Jokes

Random programming jokes on your README.

View Demo ● Report Bugs

Usage

Endpoint URL: https://readme-jokes.vercel.app/api

Embed one of these in your README:

<!-- Markdown -->

![Jokes Card](https://readme-jokes.vercel.app/api)

or

<!-- HTML -->
<img src="https://readme-jokes.vercel.app/api" alt="Jokes Card" />

Customization Parameters

• bgColor → Background Color
• borderColor → Border Color
• qColor → Question Color
• aColor → Answer Color
• textColor → Normal text Color
• codeColor → Code Color
• theme → Theme (Must be one of the following)

Click to available themes.

• default
• gradientBlue
• solidBlue
• halloween
• watermelon
• pinkish
• daySky
• radical
• merko
• gruvbox
• tokyonight
• onedark
• cobalt
• synthwave
• dracula
• prussian
• monokai
• vue
• vue-dark
• nightowl
• buefy
• blue-green
• algolia
• darcula
• bear
• solarized-dark
• solarized-light
• gotham
• material-palenight
• graywhite
• ayu-mirage
• calm
• flag-india
• omni
• react
• blueberry
• random (Will randomly select one of the above themes)

Note: Use URL-encoded # for color values i.e. %23
eg: #FFF will be %23FFF
Note: You can also use the URL parameters to customize the themes.

Demo

Known Issues

• Refreshing the jokes takes about an hour due to image caching. #2
• Not Mobile responsive. #3
• Jokes are not randomizing on different endpoint requests. #4

Contributions

• Fork this repository.
• Deploy on your own Vercel instance.
• See issues that need help.
• Open a PR, if you solve something.
• Got some idea? Just open an issue.

References

• Jokes API has been generated from wesbos/dad-jokes
• Project is inspired by anuraghazra/github-readme-stats

---

Feel free to ask any questions, open a PR if you feel something can be done differently!

🌟Star this repository🌟

Created by Abhinav Sharma | Deployed on Vercel