Closed PepeBigotes closed 1 year ago
The .gif and the logo are separated commits in case you don't want to include them, anyway they are easy to delete.
Endpoint URL: https://readme-jokes.vercel.app/api
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" />
Customize using ? after /api in the https link, example here with no borders using the hideBorder parameter.
?
/api
hideBorder
Markdown method: ![Jokes Card](https://readme-jokes.vercel.app/api?hideBorder)
![Jokes Card](https://readme-jokes.vercel.app/api?hideBorder)
Image method: <img src="https://readme-jokes.vercel.app/api?hideBorder" alt="Jokes Card" />
<img src="https://readme-jokes.vercel.app/api?hideBorder" alt="Jokes Card" />
Both methods will produce the following jokes card without border:
To use multiple parameters use & after the first parameter. For example: https://readme-jokes.vercel.app/api?hideBorder&theme=cobalt&qColor=%23944bcc&aColor=%23bbdb51
&
https://readme-jokes.vercel.app/api?hideBorder&theme=cobalt&qColor=%23944bcc&aColor=%23bbdb51
This will generate a jokes card with the next features:
cobalt
#944bcc
%23944bcc
#bbdb51
%23bbdb51
NOTE: You need to use URL-encoded # for color values (%23)
#
%23
β#FFFF00 β βοΈ%23FFFF00
#FFFF00
%23FFFF00
bgColor β Background Color Example: https://readme-jokes.vercel.app/api?bgColor=%23ff00ff (sets the color of the background to #ff00ff)
bgColor
https://readme-jokes.vercel.app/api?bgColor=%23ff00ff
borderColor β Border Color Example: https://readme-jokes.vercel.app/api?borderColor=%23ff2200 (sets the color of the border to #ff2200)
borderColor
https://readme-jokes.vercel.app/api?borderColor=%23ff2200
qColor β Question Text Color Example: https://readme-jokes.vercel.app/api?qColor=%23949494 (sets the color of the question text to #949494)
qColor
https://readme-jokes.vercel.app/api?qColor=%23949494
aColor β Answer Text Color Example: https://readme-jokes.vercel.app/api?aColor=%2300ff00 (sets the color of the answer text to #00ff00)
aColor
https://readme-jokes.vercel.app/api?aColor=%2300ff00
textColor β Normal Text Color (does not apply to answer nor question text) Example: https://readme-jokes.vercel.app/api?textColor=%23ff0a0a (sets the color of the normal text to #ff0a0a)
textColor
https://readme-jokes.vercel.app/api?textColor=%23ff0a0a
codeColor β Code Text Color Example: https://readme-jokes.vercel.app/api?codeColor=%2300ffff (sets the color of the code text to #00ffff)
codeColor
https://readme-jokes.vercel.app/api?codeColor=%2300ffff
hideBorder β Mention as a value-less parameter to hide boder Example: https://readme-jokes.vercel.app/api?hideBorder
https://readme-jokes.vercel.app/api?hideBorder
theme β Theme (Must be one from the themes list) Example: https://readme-jokes.vercel.app/api?theme=gradientBlue (applies the gradientBlue theme)
theme
https://readme-jokes.vercel.app/api?theme=gradientBlue
gradientBlue
Feel free to ask any questions, open a PR if you feel something can be done differently!
Created by Abhinav Sharma & Community | Deployed on Vercel
The latest updates on your projects. Learn more about Vercel for Git βοΈ
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:
π» Demo
π οΈ Usage
Endpoint URL:
https://readme-jokes.vercel.app/api
Embed one of these in your README:
or
ποΈ Customization Guide
Customize using
?
after/api
in the https link, example here with no borders using thehideBorder
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:
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:
cobalt
theme#944bcc
(%23944bcc
)#bbdb51
(%23bbdb51
)βοΈ Parameters Available
NOTE: You need to use URL-encoded
#
for color values (%23
)β
#FFFF00
β βοΈ%23FFFF00
bgColor
β Background ColorExample:
https://readme-jokes.vercel.app/api?bgColor=%23ff00ff
(sets the color of the background to #ff00ff)
borderColor
β Border ColorExample:
https://readme-jokes.vercel.app/api?borderColor=%23ff2200
(sets the color of the border to #ff2200)
qColor
β Question Text ColorExample:
https://readme-jokes.vercel.app/api?qColor=%23949494
(sets the color of the question text to #949494)
aColor
β Answer Text ColorExample:
https://readme-jokes.vercel.app/api?aColor=%2300ff00
(sets the color of the answer text to #00ff00)
textColor
β Normal Text Color(does not apply to answer nor question text)
Example:
https://readme-jokes.vercel.app/api?textColor=%23ff0a0a
(sets the color of the normal text to #ff0a0a)
codeColor
β Code Text ColorExample:
https://readme-jokes.vercel.app/api?codeColor=%2300ffff
(sets the color of the code text to #00ffff)
hideBorder
β Mention as a value-less parameter to hide boderExample:
https://readme-jokes.vercel.app/api?hideBorder
theme
β Theme (Must be one from the themes list)Example:
https://readme-jokes.vercel.app/api?theme=gradientBlue
(applies the
gradientBlue
theme)π CLICK HERE TO OPEN THE THEMES LIST
β οΈ 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