lewispour/git-profile-readme-banner

Generate a beautiful git profile readme banner image easily. Deployed on Vercel using FastAPI and NextJS

GitHub Profile Banner README Generator

Show your support

If you find it useful, show your support by giving the repo a 🌟! Generate a dynamic image for your GitHub Profile README using this FastAPI based API.

About

Want to make your GitHub profile stand out with a dynamic banner? With the GitHub Profile README Banner Generator, you can easily create a visually appealing banner that showcases your username + custom text, ensuring your profile doesn't go unnoticed.

Options:

• bg - Background color (hex or colour name)
• fill - Text color (hex or colour name)
• txt - Set sub heading text.
• username - Enter GITHUB username.

Default Settings

Generate a profile banner for your username with default settings:

Simply Add <p align="center"><img src="https://git-profile-readme-banner.vercel.app/api/python?username=LewisPour"></p> to your readme.

🚀 Pro Tip: Be sure to change username=LewisPour to point to your GITHUB username

• username=YourGitHubUserName make sure you use your GITHUB username

Custom Text

Use custom text for the banner:

Simply Add <p align="center"><img src="https://git-profile-readme-banner.vercel.app/api/python?username=LewisPour&txt=Here%20is%20my%20custom%20text"></p> to your readme.

🚀 Pro Tip: Add custom text using, txt=Hello%20World NOTE: This is url encoded so be sure to use %20 instead of spaces. i.e Here is my custom text would be Here%20is%20my%20custom%20text

Stylising

Generate a profile banner with a custom background and fill color:

Simply Add <p align="center"><img src="https://git-profile-readme-banner.vercel.app/api/python?username=LewisPour&bg=yellowgreen&fill=black"></p> to your readme.

🚀 Pro Tip: You can change the background and fill by using bg and fill paraments.

Example Above (Explained)

• bg=yellowgreen sets the background to yellowgreen.
• fill=black sets the text to black.

For a full list of colours check out the colour list below. All options can be used for both fill and bg

Colour List

• aliceblue
• antiquewhite
• aqua
• aquamarine
• azure
• beige
• bisque
• black
• blanchedalmond
• blue
• blueviolet
• brown
• burlywood
• cadetblue
• chartreuse
• chocolate
• coral
• cornflowerblue
• cornsilk
• crimson
• cyan
• darkblue
• darkcyan
• darkgoldenrod
• darkgray
• darkgreen
• darkgrey
• darkkhaki
• darkmagenta
• darkolivegreen
• darkorange
• darkorchid
• darkred
• darksalmon
• darkseagreen
• darkslateblue
• darkslategray
• darkslategrey
• darkturquoise
• darkviolet
• deeppink
• deepskyblue
• dimgray
• dimgrey
• dodgerblue
• firebrick
• floralwhite
• forestgreen
• fuchsia
• gainsboro
• ghostwhite
• gold
• goldenrod
• gray
• grey
• green
• greenyellow
• honeydew
• hotpink
• indianred
• indigo
• ivory
• khaki
• lavender
• lavenderblush
• lawngreen
• lemonchiffon
• lightblue
• lightcoral
• lightcyan
• lightgoldenrodyellow
• lightgray
• lightgreen
• lightgrey
• lightpink
• lightsalmon
• lightseagreen
• lightskyblue
• lightslategray
• lightslategrey
• lightsteelblue
• lightyellow
• lime
• limegreen
• linen
• magenta
• maroon
• mediumaquamarine
• mediumblue
• mediumorchid
• mediumpurple
• mediumseagreen
• mediumslateblue
• mediumspringgreen
• mediumturquoise
• mediumvioletred
• midnightblue
• mintcream
• mistyrose
• moccasin
• navajowhite
• navy
• oldlace
• olive
• olivedrab
• orange
• orangered
• orchid
• palegoldenrod
• palegreen
• paleturquoise
• palevioletred
• papayawhip
• peachpuff
• peru
• pink
• plum
• powderblue
• purple
• rebeccapurple
• red
• rosybrown
• royalblue
• saddlebrown
• salmon
• sandybrown
• seagreen
• seashell
• sienna
• silver
• skyblue
• slateblue
• slategray
• slategrey
• snow
• springgreen
• steelblue
• tan
• teal
• thistle
• tomato
• turquoise
• violet
• wheat
• white
• whitesmoke
• yellow
• yellowgreen

Tested Working - 05/04/2024