https://github.com/ABSphreak/readme-jokes

😄 Jokes for your GitHub READMEs
https://github.com/ABSphreak/readme-jokes

api hacktoberfest jokes readme-jokes vercel vercel-now

Last synced: about 1 month ago
JSON representation

😄 Jokes for your GitHub READMEs

• Host: GitHub
• URL: https://github.com/ABSphreak/readme-jokes
• Owner: ABSphreak
• License: mit
• Created: 2020-07-30T11:14:57.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-23T11:47:21.000Z (10 months ago)
• Last Synced: 2024-05-21T00:45:38.676Z (4 months ago)
• Topics: api, hacktoberfest, jokes, readme-jokes, vercel, vercel-now
• Language: JavaScript
• Homepage: https://readme-jokes.vercel.app/api
• Size: 362 KB
• Stars: 628
• Watchers: 8
• Forks: 118
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• Awesome-GithubProfile-README - readme-jokes
• awesome-github-profile - README Jokes - Random dev jokes in your GitHub README. (Tools)
• fucking-awesome-github-profile-readme - README Jokes - Random dev jokes in your GitHub README. (Tools)
• AwesomeGithubProfileTemplates - README Jokes - Random dev jokes in your GitHub README. (Resources / Tools)
• awesome-readme-tools - Readme Jokes - 😄 Jokes for your github readmes. (Miscellaneous)
• awesome-github-profile-readme - README Jokes - Random dev jokes in your GitHub README. (Tools)
• awesome-ubc-profile-readme - README Jokes - Random dev jokes in your GitHub README. (Tools)

README

        


 
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:

```md

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

```

or


```html



```

### 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:

``




Both methods will produce the following jokes card without border:

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




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](https://readme-jokes.vercel.app/api?hideBorder&theme=cobalt&qColor=%23944bcc&aColor=%23bbdb51)

#### 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](https://readme-jokes.vercel.app/api)

![Jokes Card](https://readme-jokes.vercel.app/api?bgColor=%23073b4c&textColor=%2306d6a0&aColor=%2306d6a0&borderColor=%2306d6a0)

![Jokes Card](https://readme-jokes.vercel.app/api?bgColor=%23212529&textColor=%23ffddd2&qColor=%23f94144&aColor=%2390be6d&borderColor=%23f9c74f&codeColor=%23f9c74f)

### Known Issues

- Not Mobile responsive. [#3](https://github.com/ABSphreak/readme-jokes/issues/3)

### Contributions

- Fork this repository.

- Deploy on your own [Vercel](https://vercel.com/) instance.

- See [issues](https://github.com/ABSphreak/readme-jokes/issues) that need help.

- Open a [PR](https://github.com/ABSphreak/readme-jokes/pulls), if you solve something.

- Got some idea? Just open an [issue](https://github.com/ABSphreak/readme-jokes/issues/new).

### References

- [Jokes](https://github.com/ABSphreak/readme-jokes/blob/master/src/jokes.json) API has been generated from [wesbos/dad-jokes](https://github.com/wesbos/dad-jokes)

- Project is inspired by [anuraghazra/github-readme-stats](https://github.com/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 & Community | Deployed on Vercel