Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PiyushSuthar/github-readme-quotes
🔥 Add Programming Quotes To Your GitHub Readme
https://github.com/PiyushSuthar/github-readme-quotes
github github-readme hacktoberfest profile-readme profile-readme-generator readme serverless
Last synced: about 2 months ago
JSON representation
🔥 Add Programming Quotes To Your GitHub Readme
- Host: GitHub
- URL: https://github.com/PiyushSuthar/github-readme-quotes
- Owner: PiyushSuthar
- License: mit
- Created: 2020-08-15T05:08:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-25T13:03:07.000Z (7 months ago)
- Last Synced: 2024-10-12T14:33:40.708Z (2 months ago)
- Topics: github, github-readme, hacktoberfest, profile-readme, profile-readme-generator, readme, serverless
- Language: TypeScript
- Homepage: https://quotes-github-readme.vercel.app
- Size: 156 KB
- Stars: 465
- Watchers: 6
- Forks: 73
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-github-profile - GitHub Readme Quotes - Dev quotes on your GitHub Profile Readme. (Tools)
- fucking-awesome-github-profile-readme - GitHub Readme Quotes - Dev quotes on your GitHub Profile Readme. (Tools)
- awesome-readme-tools - GitHub Readme Quotes - 🔥 Add programming quotes to your github readme. (Miscellaneous)
- awesome-github-profile-readme - GitHub Readme Quotes - Dev quotes on your GitHub Profile Readme. (Tools)
- awesome-ubc-profile-readme - GitHub Readme Quotes - Dev quotes on your GitHub Profile Readme. (Tools)
- jimsghstars - PiyushSuthar/github-readme-quotes - 🔥 Add Programming Quotes To Your GitHub Readme (TypeScript)
- awesome-github-profile - Github Readme Programming Quotes
README
Github Readme Quotes
Developer Quotes for your Github Readme.
## Features ✨
- [Dynamic quotes in your GitHub README](#Usage)
- [Customize your own quote](#Custom)
## Usage ⚡️
Copy the markdown below and paste it in your Github Readme.
```md
[](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,
```sh
pnpm install
```
And then run the app using:
```sh
npx vercel dev
```
## Usage
### Vertical
> You don't need to add **?type=vertical** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Horizontal
> You need to add **?type=horizontal** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Border
> You need to add **?border=true** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Light
> You don't need to add **?theme=light** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Dark
> You need to add **?theme=dark** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Catppuccin
> Variants:
>
> - Latte
> - Frappe
> - Macchiato
> - Mocha
> You need to add **?theme=catppuccin\_\** parameter. The current example is the Mocha variant, to use it add **?theme=catppuccin_mocha**.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Algolia
> You need to add **?theme=algolia** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Monokai
> You need to add **?theme=monokai** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Dracula
> You need to add **?theme=dracula** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
### Nord
> You need to add **?theme=nord** parameter.
[](https://github.com/piyushsuthar/github-readme-quotes)
## Custom
> You need to add **?quote=Your Quote** parameter.
> URL encode your quote.
[](https://github.com/piyushsuthar/github-readme-quotes)
## Contributing 🤝
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/PiyushSuthar/github-readme-quotes/issues).
## Special Thanks ❤
- Inspired from [AnuragHazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats).
- [skolakoda/programming-quotes-api](https://github.com/skolakoda/programming-quotes-api) for Quotes API.
- And a huge shoutout to [Mini Ware](https://github.com/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](https://twitter.com/piyushsthr)
- Github: [@PiyushSthr](https://github.com/PiyushSthr)
- LinkedIn: [@piyushsthr](https://linkedin.com/in/piyushsthr)
Made by Piyush with ❤ and TypeScript