Github Banner Generator

image

✨Usage

![alt-text](https://github-banner-generator.vercel.app/api/v1?title=Title&subtitle=Subtitle&theme=github-purple)

🎏 example banner

![my-banner](https://github-banner-generator.vercel.app/api/v1?title=GitHub%20Banner%20Generator&subtitle=created%20with%20❣️%20using%20github-banner-generator&theme=github-purple)

⚡ Note: Use %20 for space between words Example : Github Banner -> Github%20Banner

🌌 Request query

title [required] : title of the project

subtitle [optional] : short description

theme [optional]: theme name

🌈 Custom theme

You are welcome to create your own theme and submit them to the repo.

Creating custom theme :

  1. Clone the repo
  2. Copy the default theme
  3. Rename the folder to your-theme-name and edit the index.json file

{
    "name":"your-theme-name",
    "version":1,
    "backgroundImage":"bg.png",
    "backgroundColor":"#fffff",
    "primaryColor":"#000000",
    "secondaryColor":"#00000",
    "textAlign":"center",
    "fontFamily":"Roboto",
    "fontPath":"roboto.ttf"
}

⚡ Note: Make sure your theme name is unique, Banner background image size should be 1280px x 520px

Testing your theme :

  1. npm i to install all the dependencies

  2. npm run dev to start the express server

  3. open your browser and visit

    http://localhost:3000/api/v1?theme=your-theme-name

🎉 yay! you just created your first custom theme. Share your theme by creating a pull request.

GitHub

View Github