Skip to content

mao1910/readme-jokes

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

README Jokes

jokes GIF

Random programming jokes on your README.

GitHub deployments GitHub deployments GitHub issues

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 Guide

Customize using ? after /api in the https link, example here with no borders using the hideBorder parameter.

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

Image method: <img src="https://readme-jokes.vercel.app/api?hideBorder" alt="Jokes Card" />

Both methods will produce the following jokes card without border: Jokes Card
To use multiple parameters use '&' after the first parameter, e.g. ?hideBorder&theme=cobalt&qColor=%23944bcc&aColor=%23bbdb51

will produce a jokes card without border, with cobalt theme, answer color #944bcc and question color #bbdb51 like so:
Jokes Card

Parameters Available

  • bgColor β†’ Background Color
  • borderColor β†’ Border Color
  • qColor β†’ Question Color
  • aColor β†’ Answer Color
  • textColor β†’ Normal text Color
  • codeColor β†’ Code Color
  • hideBorder β†’ Mention as a value-less parameter to hide boder
  • theme β†’ Theme (Must be one of the following)
Click to see all available themes.
Theme Name Preview Image
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

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.
URL eg: https://readme-jokes.vercel.app/api?bgColor=%23073b4c&textColor=%2306d6a0&aColor=%2306d6a0&borderColor=%2306d6a0

Demo

Jokes Card

Jokes Card

Jokes Card

Known Issues

  • Not Mobile responsive. #3

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


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

🌟Star this repository🌟

Created by Abhinav Sharma & Community | Deployed on Vercel

About

πŸ˜„ Jokes for your GitHub READMEs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%