Github Readme Quotes

Developer Quotes for your Github Readme.

View Demo Report Bug

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	Description
type	vertical	Available: horizontal, vertical
theme	light	Available themes
quote	-	Customize your quote
author	-	The name of the quote's author
border	false	Available: true, false

Themes

• light
• dark
• algolia
• catppuccin
• catppuccin_frappe
• catppuccin_latte
• catppuccin_macchiato
• catppuccin_mocha
• chartreuse-dark
• dracula
• github
• github_dark
• github_blue
• graywhite
• gruvbox
• hackerman
• merko
• monokai
• moonlight
• nord
• radical
• shadow_blue
• shadow_green
• shadow_red
• tokyonight

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

Customization

Horizontal

Add the ?type=horizontal parameter.

Border

Add the ?border=true parameter.

Theme

The default theme will be light if a user is using light mode and dark themed if they are using dark mode.

Light

You need to add ?theme=light parameter.

dark

catppuccin_mocha

tokyonight

monokai

github_dark

Custom

Custom Quotes

Add the ?quote=Your Quote parameter. You must URL encode your quote.

Custom Colors

You can also customize colors directly via query parameters:

• quoteColor: Color for the quote text (hex code without #)
• authorColor: Color for the author text (hex code without #)
• backgroundColor: Color for the background (hex code without #)
• symbolColor: Color for the quote symbols (hex code without #)

Examples:

1. ?quoteColor=ff0000&authorColor=00ff00&backgroundColor=0000ff&symbolColor=ffff00

2. ?theme=dark&quoteColor=ff0000 (This will use the dark theme but override the quote color with red.)

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

Made by Piyush with ❤ and TypeScript