Giter VIP home page Giter VIP logo

github-readme-quotes's Introduction

logo

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



- Project Status: Migrated to Custom Cloud, Ongoing Code Improvement, Feature Development, and Maintenance

- Project Deployment Status: I have moved it from Heroku to custom cloud now.
Please access the content from `http://34.168.217.81:3004/quote`

- 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 Dynamic GitHub Profile Readme Quotes - Everlasting Poetic Touch to GitHub Profiles for everyone | Product Hunt

Buy Me a Coffee at ko-fi.com

Inspired by @anuraghazra



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.


  • Fonts

You can also add fonts to your templates.

Use ?font=FONT_NAME parameter as shown below

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

Font 1 (Default)

Quote

Font 2 (Redressed)

Quote

You can explore different fonts here.

Feel free to contribute different fonts.


  • 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.

Swagger Docs

To view Swagger docs, run npm start and open localhost:3002/api-docs.


  • 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

github-readme-quotes's People

Contributors

adhiraj-12 avatar afrizalyogi avatar ahmadswalih avatar albatrosspreacher avatar amitesh03 avatar bokub avatar borguuh avatar dependabot[bot] avatar dev-keshav avatar hafiz-muhammad avatar hendrasob avatar hijal avatar hsin75c avatar iqrazareef-1024 avatar isengu avatar lordpansar avatar nabaisu avatar natapg avatar nilesh-aditya avatar nishantpersonal avatar ocheops avatar olushesitoheeb avatar rededge967 avatar shravan20 avatar shubhankarnineleaps avatar shubhkotnala avatar tincho4t avatar veerbhadrasolanki avatar version0chiro avatar wasp0094 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.