Skip to content

Latest commit

 

History

History
189 lines (129 loc) · 5.4 KB

README.md

File metadata and controls

189 lines (129 loc) · 5.4 KB
Raw

GitHub Tags

Português do Brasil

      🔸 GitHub Tags API
      🔸 GitHub Colors API

Summary

    🔸 GitHub Tags API
      🔹 How to use
      🔹 Language name special symbols
      🔹 Customization
      🔹 Non colored languages
    🔸 GitHub Colors API
      🔹 How to use
    🔸 Libraries

🔸 GitHub Tags API

🔹 How to use

  Use the GitHub Tags GUI to generate your link or copy and paste the template URL below:

https://gh-tags.vercel.app/api?lang=[LANGUAGE NAME]

  Then replace the value of lang=[LANGUAGE NAME] to any language known by Github.

📃 Reference list of all languages known by Github

Let's see some examples:

Markdown

![Markdown](https://gh-tags.vercel.app/api?lang=markdown)

Response:    Markdown


HTML

<img src="https://gh-tags.vercel.app/api?lang=html" alt="HTML">

Response:    HTML


🔹 Language name special symbols

  Some language names have space, +, # or *. In those cases they are replaced by those symbols:

  • space > -
      e.g.: Regular expression > regular-expression   

  • + > -plus
      e.g.: C++ > c-plus-plus   

  • # > -sharp
      e.g.: C# > c-sharp   

  • * > -asterisk
      e.g.: F* > f-asterisk   

🔹 Customization

  There are some options to the output tag listed here:

  • size=small - This is the small version of tag. (height: 20px) - Default height: 32px.
  • type=squared - This is the squared box version of tag. - Default version: rounded.

  All the options can be added by putting a & before the chosen option. Let's see some examples:

JavaScript - small version

![JavaScript](https://gh-tags.vercel.app/api?lang=javascript&size=small)

Response:    JavaScript


JavaScript - squared version

![JavaScript](https://gh-tags.vercel.app/api?lang=javascript&type=squared)

Response:    JavaScript


JavaScript - small squared version

![JavaScript](https://gh-tags.vercel.app/api?lang=javascript&size=small&type=squared)

Response:    JavaScript


🔹 Non colored languages

  There are some languages without a specific color and they will be presented that way.


🔸 GitHub Colors API

🔹 How to use

  Use this template URL below:

https://gh-tags.vercel.app/use?lang=[LANGUAGE NAME]

  Then replace the value of lang=[LANGUAGE NAME] to any language known by Github.

⚠

Differently from GitHub Tags API this API route returns only JSON objects!


📃 Reference list of all languages known by Github

Let's see some examples:

Ada

https://gh-tags.vercel.app/use?lang=ada

returns:

{"lang":"ada","name":"Ada","color":"#02f88c"}

Json

https://gh-tags.vercel.app/use?lang=json

returns:

{"lang":"json","name":"JSON","color":"#292929"}

🔸 Libraries

  Look those amazing libraries used in this project!

   📕 @vercel/node

   📕 axios

   📕 text-to-svg

   📕 yaml