ABSphreak / readme-jokes

πŸ˜„ Jokes for your GitHub READMEs
https://readme-jokes.vercel.app/api
MIT License
646 stars 119 forks source link

Improved README.md #77

Closed PepeBigotes closed 1 year ago

PepeBigotes commented 1 year ago

Improved README.md

The .gif and the logo are separated commits in case you don't want to include them, anyway they are easy to delete.

Preview:

Logo png jokes GIF

GitHub deployments GitHub deployments GitHub issues

View Demo ● Report Bugs

πŸ’» Demo

Jokes Card

Jokes Card

Jokes Card

πŸ› οΈ 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.
For example:
https://readme-jokes.vercel.app/api?hideBorder&theme=cobalt&qColor=%23944bcc&aColor=%23bbdb51

This will generate a jokes card with the next features:

Jokes Card

βš™οΈ Parameters Available

NOTE: You need to use URL-encoded # for color values (%23)

❌#FFFF00 β†’ βœ”οΈ%23FFFF00

πŸ“ CLICK HERE TO OPEN THE THEMES LIST
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


⚠️ Known Issues

πŸ“ Contributions

πŸ“– 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

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated
readme-jokes ❌ Failed (Inspect) Feb 19, 2023 at 2:36PM (UTC)