Hi ๐,
Recently, GitHub launched Profile ReadMe and everyone started making their unique Profile Readme.
Developers made some cool tools to decorate their Profile READMEs. So after taking some inspiration from Anurag Hazra's GitHub Readme Stats, I too built something.
GitHub Readme Quotes
PiyushSuthar / github-readme-quotes
๐ฅ Add Programming Quotes To Your GitHub Readme
Github Readme Quotes
Developer Quotes for your Github Readme.
Features โจ
Usage โก๏ธ
Copy the markdown below and paste it in your Github Readme.
[![Readme Quotes](https://quotes-github-readme.vercel.app/api?type=horizontal&theme=dark)](https://github.com/piyushsuthar/github-readme-quotes)
Options
Options | Default | Available |
---|---|---|
type | vertical | horizontal, vertical |
theme | light | dark, chartreuse-dark, radical, merko, gruvbox, tokyonight, algolia, monokai, dracula, nord |
quote | - | Customize your quote |
author | - | The name of the quote's author |
border | false | true, false |
Installation and Development ๐
To get started with developing this app locally, here are the steps:
Install the dependencies for the app using,
pnpm install
And then run the app using:
npx vercel dev
Usage
Vertical
You don't need to add ?type=vertical parameter.
Horizontal
You need to add ?type=horizontal parameter.
Border
You need to add ?border=true parameter.
Light
You don't need to addโฆ
Usage
You may just copy-paste the markdown below,
[![Readme Quotes](https://quotes-github-readme.vercel.app/api?type=horizontal)](https://github.com/piyushsuthar/github-readme-quotes)
You may have noticed only a single parameter in the URL, type. I will be adding more options soon.
Options | default | Available |
---|---|---|
type | vertical | horizontal, vertical |
Preview
Vertical (Default)
You don't need to add ?type=vertical to the URL.
[![Readme Quotes](https://quotes-github-readme.vercel.app/api)](https://github.com/piyushsuthar/github-readme-quotes)
Horizontal
You need to add ?type=horizontal to the URL.
[![Readme Quotes](https://quotes-github-readme.vercel.app/api?type=horizontal)](https://github.com/piyushsuthar/github-readme-quotes)
Customization
No options for customization yet, but will be there soon. If you wish to contribute, I'll be very happy.
Extra
Some extra stuff to help you make an awesome GitHub Profile Readme.
Curated list of GitHub READMEs and Tools by Abhishek Naidu
abhisheknaiidu / awesome-github-profile-readme
๐ A curated list of awesome GitHub Profile READMEs ๐
GitHub Readme Stats by Anurag Hazra
anuraghazra / github-readme-stats
โก Dynamically generated stats for your github readmes
In the end,
I would like to thank you for reading this article. Your Contribution to the project is appreciated. Do follow me on GitHub and Twitter
Top comments (0)