microscaling / microbadger

What's inside your Docker containers?
Other
159 stars 17 forks source link

Consider the README file extension before handing out instructions on how to add a badge #6

Open sebhoss opened 8 years ago

sebhoss commented 8 years ago

Sites like GitHub/GitLab support multiple markup languages, such as Markdown and Asciidoc. While Markdown is more widely used, there are at least some people who are using Asciidoc (and other formats) to write documentation. It would be great if based on the file extension of a README, microbadger would provide the correct snippet to include a badge in the README. Example for Markdown (current default):

[![](https://images.microbadger.com/badges/image/ORGA/PROJECT.svg)](https://microbadger.com/images/ORGA/PROJECT "Get your own image badge on microbadger.com")

Example for Asciidoc:

image:https://images.microbadger.com/badges/image/ORGA/PROJECT.svg["Get your own image badge on microbadger.com", link="https://microbadger.com/images/ORGA/PROJECT"]