github-readme-quotes
github-readme-quotes copied to clipboard
๐ฅ Add Programming Quotes To Your GitHub Readme
Github Readme Quotes
Developer Quotes for your Github Readme.
Features โจ
- Dynamic quotes in your GitHub Readme.
- Customize your own quote.
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 |
myquote | - | Customize your quote |
author | - | The name of the quote's author |
Installation and Development ๐
To get started with developing this app locally, here are the steps:
Install the dependencies for the app using,
npm install
# or
yarn
And, then run the app using,
npx vercel dev
# or
yarn run vercel dev
Demo
Vertical
You don't need to add ?type=vertical parameter.
Horizontal
You need to add ?type=horizontal parameter.
Light
You don't need to add ?theme=light parameter.
Dark
You need to add ?theme=dark parameter.
Catppuccin
You need to add ?theme=catppuccin parameter.
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 ?myquote=Your Quote parameter. URL encode your quote.
Adding Soon ๐ง
- Customization Options
- More features
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