dhyeythumar / youtube-stats-card Goto Github PK

Get dynamically generated YouTube Stats Cards for your github readmes & websites!

View Demo · Report Bug · Request Feature

• YouTube Channel Stats Card
  • Usage
  • Layout Demos
  • Customization
  • Overview
• YouTube Video Stats Card
  • Usage
  • Layout Demos
  • Customization
  • Overview
• Contribution
• Support the project
• License
• Acknowledgements

[![Dhyey's youtube stats](https://youtube-stats-card.vercel.app/api?channelid=UCpKizIKSk8ga_LCI3e3GUig)](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig)

Change the ?channelid= value to your YouTube Channel ID.

Check out this to get your youtube channel id.

Below layouts uses default parameters*

Layouts	Preview
Default Layout
Center Layout &layout=center
Exruded Layout &layout=extruded

All the Customizations are applied to the default layout*

Parameters	Preview
Hide Icons &hide_icons=true
Hide Logo &hide_logo=true
Color Theme &theme=THEME_NAME
Hide Border &hide_border=true
Manual Color Theme &title_color=cbf7db&icon_color=99ffbe &text_color=fffefe&bg_color=40423e
Custom Title custom_title=My%20Channel%20Name

Check all the available color themes here or checkout the theme config file & you can also contribute new themes if you like 🙂.

You can customize the appearance of your Channel Stats Card with following URL params:

• hide_icons - Hide the icons from channel card (boolean)
• hide_logo - Hide the logo from channel card (boolean)
• theme - Name of the theme, choose from all available themes
• hide_border - Hides the card's border (boolean)
• title_color - Card's title color (hex color)
• text_color - Body text color (hex color)
• icon_color - Icons color if available (hex color)
• bg_color - Card's background color (hex color)
• custom_title - Add custom title to the channel card (use %20 to add space)
• cache_seconds - set the cache header manually (min: 1800, max: 86400)

Note on cache: All cards have a default cache of 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.

• • • •

[![Dhyey's video stats](https://youtube-stats-card.vercel.app/api/video?videoid=4vwZNTagHsQ)](https://youtu.be/4vwZNTagHsQ)

Change the ?videoid= value to your youtube video ID.

Check out this to get your youtube video id.

Below layouts uses default parameters*

Layouts	Preview
Default Layout
Compact Layout &layout=compact

All the Customizations are applied to the default layout*

Parameters	Preview
Hide Icons &hide_icons=true
Hide Video Preview &hide_preview=true
Color Theme &theme=THEME_NAME
Hide Border &hide_border=true
Manual Color Theme &title_color=cbf7db&icon_color=99ffbe &text_color=fffefe&bg_color=40423e
Hide Channel Name &hide_channelname=true

Check all the available color themes here or checkout the theme config file & you can also contribute new themes if you like 🙂.

You can customize the appearance of your Video Stats Card with following URL params:

• hide_icons - Hide the icons from video card (boolean)
• hide_preview - Hide the video preview from video card (boolean)
• theme - Name of the theme, choose from all available themes
• hide_border - Hides the card's border (boolean)
• title_color - Card's title color (hex color)
• text_color - Body text color (hex color)
• icon_color - Icons color if available (hex color)
• bg_color - Card's background color (hex color)
• hide_channelname - Hide the channel name in video card
• cache_seconds - set the cache header manually (min: 1800, max: 86400)

Note on cache: All cards have a default cache of 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.

If you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-

• Giving proper credit when you use youtube-stats-card on your readme.
• Starring and sharing the project.

If you would like to see a feature implemented, don't hesitate to add it to the issues list, or better is to create pull request 😎

Contributions are welcome!

Licensed under the MIT License.

Inspired by anuraghazra's github-readme-stats