jsx-readme/lib/components/Badge.d.ts

Generate Readme files with a React-like syntax and package.json-aware helpers.

import type { Component } from "jsx-md";
/** @internal */
interface Props {
    link: string;
    imageSource: string;
    children: string;
}
/**
 * Creates a readme badge (linked image).
 * @example
 *   ```js
 *   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'
 *   ```
 */
export declare const Badge: Component<Readonly<Props>>;
export {};