Badges

Add inline labels to highlight status, versions, or categories.

Types

Default Success Warning Danger

Feature Status

Highlight new, beta, or deprecated features:

Search New

The search feature now supports fuzzy matching.

Dark Mode Beta

Dark mode is available for testing.

Legacy API Deprecated

The old API will be removed in v3.0.

Version Labels

Mark documentation by version:

Installation v1.2.0

This feature is available in version 1.2.0 and later.

New Syntax v2.0.0

Breaking change introduced in v2.0.

Inline Usage

Badges work inline with text: The recommended approach is to use environment variables for sensitive configuration.

In Tables

Feature Status
Dark mode Stable
Search Beta
Plugins Coming Soon
Old API Deprecated

In Lists

  • Required Install Ruby 3.0 or later
  • Optional Configure custom domain
  • Advanced Enable experimental features

Syntax 

:badge[Text]
:badge[Text]{type="success"}
:badge[Text]{type="warning"}
:badge[Text]{type="danger"}

Reference

Type Syntax Use Case
Default :badge[Text] General labels, versions
Success :badge[Text]{type="success"} New features, stable, recommended
Warning :badge[Text]{type="warning"} Beta, experimental, caution
Danger :badge[Text]{type="danger"} Deprecated, breaking changes, errors
Edit this page
Last updated
Built with Docyard