Awesome
<p align="center"> <img align="center" width="100" src="assets/logo.png" /> <h1 align="center">Github Readme Quotes</h1> <h3 align="center">Developer Quotes for your Github Readme.</h3> </p> <!-- Badges --> <p align="center"> <a href="https://github.com/PiyushSuthar/github-readme-quotes/issues"> <img src="https://img.shields.io/github/issues/PiyushSuthar/github-readme-quotes?style=flat-square"> </a> <a href="https://github.com/PiyushSuthar/github-readme-quotes/pulls"> <img src="https://img.shields.io/github/issues-pr/PiyushSuthar/github-readme-quotes?style=flat-square"> </a> <a href="https://twitter.com/piyushsthr" target="_blank"> <img alt="Twitter: piyushsthr" src="https://img.shields.io/twitter/follow/piyushsthr.svg?style=social" /> </a> </p> <!-- Links --> <p align="center"> <a href="https://quotes-github-readme.vercel.app/api" target="_blank">View Demo</a> <span> · </span> <a href="https://github.com/piyushsuthar/github-readme-quotes/issues" target="_blank">Report Bug</a> </p>Features ✨
Usage ⚡️
Copy the markdown below and paste it in your Github Readme.
[](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 ?theme=light parameter.
Dark
You need to add ?theme=dark parameter.
Catppuccin
Variants:
- Latte
- Frappe
- Macchiato
- Mocha
You need to add ?theme=catppuccin_<variant> parameter. The current example is the Mocha variant, to use it add ?theme=catppuccin_mocha.
Algolia
You need to add ?theme=algolia parameter.
Monokai
You need to add ?theme=monokai parameter.
Dracula
You need to add ?theme=dracula parameter.
Nord
You need to add ?theme=nord parameter.
Custom
You need to add ?quote=Your Quote parameter. URL encode your quote.
Contributing 🤝
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Special Thanks ❤
- Inspired from AnuragHazra/github-readme-stats.
- skolakoda/programming-quotes-api for Quotes API.
- And a huge shoutout to Mini Ware for his immense contribution to this project!
Show your support 🌈
Be sure to drop a 🌟 if you like the project!
Author 🤗
👤 Piyush Suthar
- Website: https://piyushsuthar.github.io
- Twitter: @piyushsthr
- Github: @PiyushSthr
- LinkedIn: @piyushsthr