https://github.com/shravan20/github-readme-quotes
Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes
https://github.com/shravan20/github-readme-quotes
express first-timers good-first-issue good-first-issues hacktoberfest hacktoberfest-accepted hacktoberfest2022 hacktoberfest2023 node node-js nodejs profile-readme quote-generator quotes react reactjs readme-generator readme-md
Last synced: 7 days ago
JSON representation
Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes
- Host: GitHub
- URL: https://github.com/shravan20/github-readme-quotes
- Owner: shravan20
- License: mit
- Created: 2020-11-08T19:27:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-03T07:07:52.000Z (4 months ago)
- Last Synced: 2025-03-31T22:16:03.702Z (14 days ago)
- Topics: express, first-timers, good-first-issue, good-first-issues, hacktoberfest, hacktoberfest-accepted, hacktoberfest2022, hacktoberfest2023, node, node-js, nodejs, profile-readme, quote-generator, quotes, react, reactjs, readme-generator, readme-md
- Language: JavaScript
- Homepage: https://github-readme-quotes-returns.vercel.app/
- Size: 10.7 MB
- Stars: 287
- Watchers: 12
- Forks: 162
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- project-awesome - shravan20/github-readme-quotes - Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes (JavaScript)
- LearningResources - Dynamic-Github-README-Quotes
- awesome-lists - Awesome GitHub Quotes for README
- awesome-github-profile - Github Readme Quotes
README
Github Readme Quotes: Dynamic quote generator for your GitHub readmes
   [](https://github.com/shravan20/github-readme-quotes/graphs/contributors)    [](https://github.com/shravan20/github-readme-quotes/)
## Current status
- [x] Project Status: Migrated to Vercel Cloud
- [x] Project Deployment Status: I have moved it from Heroku to Vercel Cloud now. Please access the content from UI on **[https://github-readme-quotes-returns.vercel.app](https://github-readme-quotes-returns.vercel.app)** and utility on **[https://github-readme-quotes-bay.vercel.app/quote](https://github-readme-quotes-bay.vercel.app/quote)**
- [x] Self-Hosting and Contributions: If you wish to host the project on your own,
you can fork the repository and deploy it according to your needs. Feel free to reach
out to me if you require any assistance or have inquiries about the project.
Your contributions and involvement in the project are welcome.
---
Featuring on 
Inspired by @anuraghazra
---
### Use [User Interface](https://github-readme-quotes-bay.vercel.app/), to view designed quotes and copy link and paste it directly
---
## Features
| Sl No | Feature Name | Description |
|:-:|:-:|:-:|
| 1 | [Dynamic Quotes](#github-readme-quotes-1) | Different quotes every time its rendered for GitHub Profile Readme |
| 2 | [Colorful Themes](#themes) | Various colorful themes available for cards |
| 3 | [Design Layouts](#layouts) | Different Layout design cards are available |
| 4 | [Animation](#animations) | Animations available for quote cards |
| 5 | [Custom Quotes from GitHub Gists](#custom-quotes) | You can add custom quotes of your own or own choice from GitHub Gists json files |
| 6 | [Quotes based on Category](#category-based-quotes) | Different category based quotes are available |
---
Note: To read an article on this project, please refer:
GitHub Profile README : Animated Dynamic Quote Generator
---
# Github Readme Quotes
Copy and paste the following markdown content to display the quote.
```md
```
- ### Themes
You can display your quote in different themes without any manual customization.
Use `?theme=THEME_NAME` parameter as shown below.
```md
```
#### Available Themes
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
**Dark**
**Light Theme**
You can explore different themes [here](./src/themes/README.md).
Feel free to contribute different themes.
---
- ### Layouts
You can also change the layout of your templates.
Use `?layout=LAYOUT` parameter as shown below
```md
```
#### Layout 1 (Default)
#### Layout 2 (Socrates)
You can explore different layouts [here](./src/layouts/README.md).
Feel free to contribute different layouts.
---
- ### Fonts
You can also add fonts to your templates.
Use `?font=FONT_NAME` parameter as shown below
```md
```
#### Font 1 (Default)
#### Font 2 (Redressed)
You can explore different fonts [here](./src/fonts/README.md).
Feel free to contribute different fonts.
---
- ### Animations
You can also add animations to your templates.
Use `?animation=ANIMATION` paramater as shown below
```md
```
#### Animation 1
You can explore different animations [here](./src/animations/README.md).
---
- ### Custom Quotes
You can also provide a file with the list of quotes and a random quote will be generated for you.
#### Follow the steps to provide your own custom quotes
- Use the template provided at [here](./customQuotes/quotes.json) and write your own file with multiple quotes.
- Save the file in the repository in any (public) directory or anywhere in the internet.
- Get the link of the file.
- Use `?quotesUrl=URL` as shown below
```
```
---
- ### Category based Quotes
You can also provide a category to fetch the list of quotes based on certain category and a random quote will be generated for you based on category you specify.
#### Available Categories
| | | | |
|------------|------------|------------|------------|
| general | life | success | motivational|
| fun | programming| dream | failure |
| gaming | birthday | Humorous | Travel |
- Use `quoteCategory=categoryName` as shown below
```
```
Feel free to contribute different quotes to different categories.
#### Follow the steps to add quotes to category
- Add the quote you want in this [file](./customQuotes/category.json) based on the category it falls into.
- If the category you want doesn't exist, feel free to add the category in this [file](./customQuotes/category.json) and add the quotes.
---
- ### Border Color
You can customize the border color of your templates. Please note that this feature is available only with the Default layout.
Use `?borderColor=COLOR` paramater as shown below
```md
```
---
## Swagger Docs
To view Swagger docs, run `npm start` and open .
---
Huge Shoutout to all the Star-Gazers
Huge Shoutout to all the Forkers
