Skip to content

Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes

License

Notifications You must be signed in to change notification settings

gokulsaraswat/github-readme-quotes

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

github-readme-quotes

Dynamic quote generator for your GitHub readmes

banner

alt PRs Welcome Open Source? Yes! GitHub contributors Pull Request Counts last commit deployment-status Build Status

Featuring on Dynamic GitHub Profile Readme Quotes - Everlasting Poetic Touch to GitHub Profiles for everyone | Product Hunt


Use User Interface, to view designed quotes and copy link and paste it directly


Features

Sl No Feature Name Description
1 Dynamic Quotes Different quotes every time its rendered for GitHub Profile Readme
2 Colorful Themes Various colorful themes available for cards
3 Design Layouts Different Layout design cards are available
4 Animation Animations available for quote cards
5 Custom Quotes from GitHub Gists You can add custom quotes of your own or own choice from GitHub Gists json files
6 Quotes based on Category 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.

![Quote](https://github-readme-quotes.herokuapp.com/quote)



  • Themes

You can display your quote in different themes without any manual customization.

Use ?theme=THEME_NAME parameter as shown below.

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark)

Available Themes

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

Dark

Quote

Light Theme

Quote

You can explore different themes here.

Feel free to contribute different themes.


  • Layouts

You can also change the layout of your templates.

Use ?layout=LAYOUT parameter as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&layout=socrates)

Layout 1 (Default)

Quote

Layout 2 (Socrates)

Quote

You can explore different layouts here.

Feel free to contribute different layouts.


  • Animations

You can also add animations to your templates.

Use ?animation=ANIMATION paramater as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&animation=grow_out_in)

Animation 1

Quote

You can explore different animations here.


  • 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 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
    ![Quote](https://github-readme-quotes.herokuapp.com/quote?quotesUrl=https://github.com/ShubhKotnala/github-readme-quotes/blob/custom-quotes/customQuotes/quotes.json)
    

Quote


  • 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

  • motivational

  • fun

  • life

  • general

  • programming

  • success..etc.

    • Use quoteCategory=categoryName as shown below
     ![Quote](https://github-readme-quotes.herokuapp.com/quote?quoteCategory=motivational)
    

Quote

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 based on the category it falls into.
  • If the category you want doesn't exist, feel free to add the category in this file and add the quotes.

  • Huge Shoutout to all the Star-Gazers

Stargazers repo roster for @shravan20/github-readme-quotes


  • Huge Shoutout to all the Forkers

Forkers repo roster for @shravan20/github-readme-quotes

About

Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.3%
  • CSS 1.4%
  • HTML 1.1%
  • Shell 0.2%