open-consul/website/components/enterprise-alert/README.md

1.2 KiB

Enterprise Alert Component

This component is an easy way to mark some content as only applicable to the enterprise version of consul. It can be used in any documentation pages in a variety of ways. The basic implementation is written as such, on its own line within a markdown file:

<EnterpriseAlert />

And renders like this

The default text can also be replaced with custom text as such:

<EnterpriseAlert>
  Custom text <a href="">with a link</a>
</EnterpriseAlert>

Which renders as such

Finally, it can be rendered inline as a "tag" to mark a section or option as enterprise only by adding the inline attribute:

<EnterpriseAlert inline>

This is typically used after a list item, or after a headline. It renders as such