Image for post
Image for post
Photo by Annie Spratt on Unsplash

CODEX

Adding Banners and Images to Your Github Repository

Erikka Innes
Jan 22 · 3 min read
Image for post
Image for post
An example of a useful diagram I added to a github readme file

Sometimes developer relations projects are about adding marketing appeal to existing content your company offers. Sometimes they’re about clarifying a concept with a diagram. One great way to improve the appeal of your repository is by adding banners to your github repositories. And you can add clarity for difficult concepts with a diagram.

When you add a banner, it makes the repository look more official, and it helps brand active, stable company repositories. You can use banners to show a repository is tended regularly, to draw the reader’s eye so they check out your readme file and project, and even to provide quick details about what the repository contains. For important technical concepts, including diagrams detailing how something works can make your repository more usable.

There’s two places you may want to use a banner or diagram in Github:

  • Your readme file

Your Social Preview

The social preview section on github is available for every repository. This lets you decide what will appear when you share your repository on social media. It provides a template for creating the perfect image, and it’s easy to add your image file. To add an image, take these steps:

  1. Navigate to a repository you have access to on github.

Your Readme File

It’s great to include a banner at the top of your repository’s readme file. To do this, all you need to do is:

  1. Prepare a banner. The banner dimensions are best if they’re 1280x640px.

CodeX

Everything connected with Code & Tech!

Medium is an open platform where 170 million readers come to find insightful and dynamic thinking. Here, expert and undiscovered voices alike dive into the heart of any topic and bring new ideas to the surface. Learn more

Follow the writers, publications, and topics that matter to you, and you’ll see them on your homepage and in your inbox. Explore

If you have a story to tell, knowledge to share, or a perspective to offer — welcome home. It’s easy and free to post your thinking on any topic. Write on Medium

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store