AiroPi / banner.md

Dynamically generate a great banner using github informations !

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

banner

Static Badge

banner.md

banner.md let your generate easly beautiful banners for your projects, like the one above. They are dynamically generated, fetching your datas from Github directly!

More customisations will be available soon, but for now, you can :

  • set a title
  • set a description
  • set a GitHub repository to fetch datas from

Using

  • Golang : an open-source programming language supported by Google

How to use

You can integrate your own banner using this project by adding an image HTML tag (or a Markdown image integration).

For example:

<img src="https://bannermd.airopi.dev/banner?title=banner.md&desc=Generate%20beautiful%20banner%20for%20your%20projects!&repo=AiroPi/banner.md" width="100%" alt="banner"/>

The base url is https://bannermd.airopi.dev/banner.

The query parameters are :

  • title: the name of the project
  • desc: the description of the project
  • repo: the Github repository name. (AccountName/RepositoryName)

Support, Feedback and Community

You can reach me over Discord at @airo.pi. Feel free to open an issue if you encounter any problem!

How to contribute

I would ❤️ to see your contribution! Refer to CONTRIBUTING.md

License

banner.md is under the MIT License.

Credits

Banner background from SVGBackgrounds.com (going to be changed).

About

Dynamically generate a great banner using github informations !

License:MIT License


Languages

Language:Go 94.7%Language:Dockerfile 5.3%