TYPO3 Badges

A beautiful eye-catcher for your extension documentations.

TER extensions only
Please note: Only TYPO3 extensions published at TYPO3 extension repository (TER) are supported, because all extension metadata are fetched from TER REST API.

🚀 Usage

This API provides endpoints for Badgen and Shields.io, allowing badges to be rendered.

Each endpoint supports the svg format with the rendered SVG badge and the json format with JSON data for external badge providers.

🔥 Endpoints

🤖 JSON response schema

Badgen

All JSON endpoints return objects to be processed by Badgen. 

{
    "subject": "typo3",
    "status": "inspiring people to share",
    "color": "orange"
}

Take a look at the official documentation of Badgen to get an overview about how JSON data is processed.

Shields.io

All JSON endpoints return objects to be processed by Shields.io. 

{
    "schemaVersion": 1,
    "label": "typo3",
    "message": "inspiring people to share",
    "color": "orange",
    "isError": false,
    "namedLogo": "typo3"
}

Take a look at the official documentation of Shields.io to get an overview about how JSON data is processed. There you will also find ways to override the configuration sent by the API.

🤔 Anything else?

If you are missing something, feel free to create an issue or submit a pull request.

🧡 Like it?

I created this project in my spare time. If you like it, please consider sponsoring me. Thank you!