/social-preview

:octocat: Generate a stylish meta (social media) preview for your own GitHub repository. A different image is generated for every repository. Use your Github-assigned language colors too!

Primary LanguageTypeScriptMIT LicenseMIT

⚠️ GitHub has started to make their own dynamic meta images, this project is being discontinued and archived.

Social Preview

GitHub Social Preview

Generate a stylish meta social preview for your GitHub repository

Released under the MIT license. This Repository uses a generated Social Preview from @pqt/social-preview

Welcome

On April 16th, 2019 GitHub released repository social media image functionality. Since then it's gone widely unused by small-scale projects and meta data remains the owner (or organization) avatar image instead.

This web app makes it dead simple to put in your username (or organization name) and the repository, then download an image that blends in with the branding of GitHub already. Zero effort and stylish.

Support this project

Like all good software engineers I accept payments in dollars and exposure!

This Repository uses a generated Social Preview from @pqt/social-preview

You can pop this bad boy on your repository free of charge. It's a small nod to the work put into this project, and will make me feel all warm and fuzzy inside when I search around and see who might be using a generated social preview on their projects.

[![This Repository uses a generated Social Preview from @pqt/social-preview](https://img.shields.io/badge/%E2%9C%93-Social%20Preview-blue)](https://github.com/pqt/social-preview)

or HTML:

<a href="https://github.com/pqt/social-preview">
  <img
    src="https://img.shields.io/badge/%E2%9C%93-Social%20Preview-blue"
    alt="This Repository uses a generated Social Preview from @pqt/social-preview"
  />
</a>

If you prefer the money route my GitHub Sponsors page is always an appreciated alternative method of support.

License

MIT