Function Badge

Creates a readme badge (linked image).

Example

  render(
<Badge
link='https://npmjs.org/package/package-name'
imageSource='https://badge.fury.io/js/package-name.svg'
>
npm package
</Badge>
)
===
'[![npm package](https://badge.fury.io/js/package-name.svg)](https://npmjs.org/package/package-name)\n'
  • Parameters

    • props: Readonly<Props>

    Returns null | MarkdownElement<unknown>

Generated using TypeDoc