Improved README.md #77
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- add old gif reference - small markdown violation fixes -add a div to the hideBorder exemple card in an attempt to fix it (it overlays the text, at least on my PC and mobile) - make "parameter stacking" example better - add a div to the "parameter stacking" example card, just in case.
- Demo reference fix test 2 - Move the Demo section to the start - Change the " '#' needs to be '%23' " note to make it more visible and graphic - Erase the '&' in the examples from the parameters list. - Point the hex number on these examples. - Change themes list title emoji - Some other minor changes
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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/apiEmbed one of these in your README:
or
🖌️ Customization Guide
Customize using
?after/apiin the https link, example here with no borders using thehideBorderparameter.Markdown method:
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=%23bbdb51This will generate a jokes card with the next features:
cobalttheme#944bcc(%23944bcc)#bbdb51(%23bbdb51)⚙️ Parameters Available
NOTE: You need to use URL-encoded
#for color values (%23)❌
#FFFF00→ ✔️%23FFFF00bgColor→ 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?hideBordertheme→ Theme (Must be one from the themes list)Example:
https://readme-jokes.vercel.app/api?theme=gradientBlue(applies the
gradientBluetheme)📝 CLICK HERE TO OPEN THE THEMES LIST
📝 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