/github-readme-quotify

Add quotes programming, inspirational, motivation or even mixed to your readme :)

Primary LanguageTypeScript

Quotify For Readme

Programming, Normal Or Even Mixed Quotes For Your Readme.

⚡ Setup

Copy the markdown below and paste it in your profile Github Readme.

[![Quotify](https://github-readme-quotify.vercel.app/api?mode=mixed&type=horizontal&theme=monokai)](https://github.com/Vishal-beep136/github-readme-quotify)

Parameters or Options

Options Default About and available
mode programming Quotes mode decides which type of qoutes you want. Available - programming,normal,mixed
type vertical card type - horizontal, vertical
theme light card theme dark, chartreuse-dark, radical, merko, gruvbox, tokyonight, algolia, monokai, dracula, nord.
quote - Customize your quote if you want to display your own otherwise not needed
author Me The name of the quote's author

Usage

Quote Mode

Programming

In this mode where you get quotes releated to programming only.

You don't need to add ?mode=programming

Quotify

Normal

In this mode where you get famous quotes

You need to add ?mode=normal

Quotify

Mixed

Why not both! In this mode you will get either Programming or Normal

You need to add ?mode=mixed

Quotify

Card Type

Vertical

You don't need to add ?type=vertical parameter.

Quotify

Horizontal

You need to add ?type=horizontal parameter.

Quotify

Themes

Light

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

Quotify

Dark

You need to add ?theme=dark parameter.

Quotify

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.

Quotify

Algolia

You need to add ?theme=algolia parameter.

Quotify

Monokai

You need to add ?theme=monokai parameter.

Quotify

Dracula

You need to add ?theme=dracula parameter.

Quotify

Nord

You need to add ?theme=nord parameter.

Quotify

Custom

You need to replace the value after ?quote= with your text use + or %20 for spaces Example - "?quote=My%20Quote"

Quotify

Development 🚀

To get started with developing this app locally, here are the steps:

Install the dependencies for the app using,

npm install

And then run the app using:

npx vercel dev

Likes This Project

Consider giving a star 🌟

Contributing 🤝

Contributions, issues and feature requests are always welcome!

Special Thanks ❤



Made by Vishal with 💙 and TypeScript