Skip to content

Latest commit

 

History

History
170 lines (106 loc) · 5.57 KB

README.md

File metadata and controls

170 lines (106 loc) · 5.57 KB

Github Readme Quotes

Developer Quotes for your Github Readme.

Twitter: piyushsthr

View Demo · Report Bug

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.

readme Quotes

Horizontal

You need to add ?type=horizontal parameter.

readme Quotes

Border

You need to add ?border=true parameter.

readme Quotes

Light

You don't need to add ?theme=light parameter.

readme Quotes

Dark

You need to add ?theme=dark parameter.

readme Quotes

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.

readme Quotes

Algolia

You need to add ?theme=algolia parameter.

readme Quotes

Monokai

You need to add ?theme=monokai parameter.

readme Quotes

Dracula

You need to add ?theme=dracula parameter.

readme Quotes

Nord

You need to add ?theme=nord parameter.

readme Quotes

Custom

You need to add ?quote=Your Quote parameter. URL encode your quote.

readme Quotes

Contributing 🤝

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Special Thanks ❤

Show your support 🌈

Be sure to drop a 🌟 if you like the project!

Author 🤗

👤 Piyush Suthar

Made by Piyush with ❤ and TypeScript