{{< asyncapi >}}

Description#

The asyncapi shortcode allows to display an AsyncAPI documentation associated to a service.

Parameters#

NameType(named/positional)Description
sourcenamedSource of the AsyncAPI documentation.
NB: The source can be either a local path or an URL.

Examples#

MarkdownRendering
{{</* asyncapi
  source="asyncapi/example.yaml"
*/>}}
Loading
{{</* asyncapi
  source="https://raw.githubusercontent.com/asyncapi/spec/master/examples/simple-asyncapi.yml"
*/>}}
Loading