piyushsuthar / github-readme-quotes

🔥 Add Programming Quotes To Your GitHub Readme

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	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

Made by Piyush with ❤ and TypeScript

github-readme-quotes's Issues

How to create these type of api's?

Can anyone tell what is the tech stack used in these project and how it is implemented? And can we implement the same thing using flask?

Suddenly Stopped Working

The app seemed to have suddenly stopped working for me. This is what I see when I visit the repo README:

My GitHub Profile used to have the quote working properly, but it stopped working without me changing anything. The Network Debug tab shows 502 for that too. Is this a problem at the backend Vercel server, or is it a problem at my end? I've tried with multiple devices with multiple WiFi networks, so I doubt that. Please let me know if you're facing the same issue.

Select just a set of quotes

I'd like to have an option to select a set of quotes. I don't like some of them, like Elon's and others.

Bottom border not visible

Hi, thank you for your generous work. I tried to include a quote but the generated quote might have exceeded the limit hence, the bottom border is not visible. But it works perfectly fine when "type=vertical"
Can this be fixed?

Default system-defined light/dark color-scheme mode

Would it be reasonable to implement a default light/dark mode instead of just light mode with equivalent functionality to the CSS prefers-color-scheme? That is, remove the requirement of a user manually entering their dark (or light) mode preference without affecting remaining existing functionality. If you agree to this @PiyushSuthar, can I please be assigned to the task.

How to deal with the quote when it includes "&" character?

Example:
My expect quote is "A & B & C",

https://quotes-github-readme.vercel.app/api?type=horizontal&theme=dark&quote=A & B & C 

Enhancement: `graywhite` Theme

I made a PR which adds a new theme (graywhite).

Additionally, one question, does symbol refer to the double quotes ("")?

Let me know!

Note: Feel free to close this once merged or for discussion.

Cusmtomization

There are no options for customization like theme and border.

Incorrect Bottom Border

I don't know if it's by designed or it's displayed incorrectly, but would appreciate if you can fix the bottom border.

Something broke

I'm seeing this kind of error instead of quote:

also in this repo readme:

dark mode color

dark mode background color of quotes should be match with github dark mode, should not set to black

Too long quote

Some quotes are too long for the card to contain. Provide some customization to the card might solve the problem.

Quotes too large

How do i fix this?

Add Customization Options

Just realized there are no customization options in this project.

If you think you can add, Go Ahead!