readme
  • Introduction
  • Generic
    • Logo
    • Badges
    • Emojis
  • readme-java
    • Getting Started
Powered by GitBook
On this page
  1. Generic

Logo

PreviousIntroductionNextBadges

Last updated 4 months ago

The logo of your GitHub repository should be the first thing a potential user sees when they view your README. The recommended width for your logo is 830 since that matches the standard desktop size of the markdown container on GitHub. Keep in mind that components - including your logo - will get scaled depending on the size of the display window. The recommended height relative to the mentioned width is 207 (floor(width / 4)). This ensures a modern, banner-like look. If you don't want to design a logo yourself or just need a placeholder until you find the time to work on one you can use our completely free, on-demand, placeholder logo generation service:

https://tools.etdon.com/placeholder-image/

In order to generate a logo simply send a request to the generate endpoint and provide all required values as query parameters:

Parameter
Description

width

The width of the image. (1-2056)

height

The height of the image. (1-2056)

background-color

The hex background color without any prefixes, for example FFFFFF.

text

The text. (Up to 32 characters)

text-color

The hex text color without any prefixes, for example FFFFFF.

If you're feeling extra fancy you can provide up to 6 comma-separated background-color values which will generate a gradient background.

Example:

https://tools.etdon.com/placeholder-image/generate?width=830&height=207&background-color=2596be,154c79&text=Hello%20World!&text-color=ffffff
The generated image of the provided example request.