Home Explore Blog CI



docker

content/contribute/components/badges.md
9d22b69c8e6b976acdd0a0b2a096d33a089b4ef2688d9814000000030000041a
---
description: components and formatting examples used in Docker's docs
title: Badges
toc_max: 3
---

### Examples

{{< badge color=blue text="blue badge" >}}
{{< badge color=amber text="amber badge" >}}
{{< badge color=red text="red badge" >}}
{{< badge color=green text="green badge" >}}
{{< badge color=violet text="violet badge" >}}

You can also make a badge a link.

[{{< badge color="blue" text="badge with a link" >}}](../_index.md)

### Usage guidelines

We use badges to indicate new content and product content in various stages of the release lifecycle: 

- The violet badge to highlight new early access or experimental content 
- The blue badge to highlight beta content 
- The green badge to highlight new content that is either GA or not product-related content, such as guides/learning paths

Best practice is to use this badge for no longer than 2 months post release of the feature.

### Markup

```go
{{</* badge color=amber text="amber badge" */>}}
[{{</* badge color="blue" text="badge with a link" */>}}](../overview.md)
```

Chunks
75e975ab (1st chunk of `content/contribute/components/badges.md`)
Title: Badges: Examples, Usage, and Markup
Summary
This section describes the usage of badges in Docker documentation. It provides examples of different colored badges (blue, amber, red, green, violet) and demonstrates how to create a badge as a link. It outlines the guidelines for using badges to indicate new, beta, early access, or experimental content, as well as general availability (GA) or non-product-related content. The section also includes the markup code for implementing badges.