Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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 (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T11:47:21.000Z (12 months ago)
- Last Synced: 2024-10-11T18:42:14.124Z (about 1 month ago)
- Topics: api, hacktoberfest, jokes, readme-jokes, vercel, vercel-now
- Language: JavaScript
- Homepage: https://readme-jokes.vercel.app/api
- Size: 362 KB
- Stars: 651
- Watchers: 9
- Forks: 119
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
README Jokes
Random programming jokes on your README.
### Usage
Endpoint URL: `https://readme-jokes.vercel.app/api`
Embed one of these in your README:
```md
```
or
```html
```
### Customization Guide
Customize using `?` after /api in the https link, example here with no borders using the `hideBorder` parameter.
Markdown method:
``
Image method:
`
`
Both methods will produce the following jokes card without border:
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:
#### 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
### 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