Badges

Badges are small colored labels that flow inline with text. Use them for status indicators, version tags, and categories.

Types

Syntax:

:::badge{type="success"}
Label Text
:::

Inline with Text

The :::badgeNew::: API endpoint supports :::badgeBeta::: features alongside :::badgeStable::: ones.

Common Patterns

Status labels: :::badgePublished::: :::badgeDraft::: :::badgeDeprecated:::

Version tags: :::badgev3.0::: :::badgev2.x::: :::badgeLatest:::

HTTP methods: :::badgeGET::: :::badgePOST::: :::badgePUT::: :::badgeDELETE:::

Best Practices

• Use consistent colors for the same meaning across your documentation
• Keep badge text short --- one or two words
• Don't overuse badges; they lose impact when everything is labeled