JSDocExample

Create a JSDoc example set off with @example. When the fenced prop is true, a language prop can also be set.

jsx

import { JSDocExample } from "@alloy-js/typescript";

<JSDocExample fenced language="string">
  {children}
</JSDocExample>

stc

import { JSDocExample } from "@alloy-js/typescript/stc";

JSDocExample({ fenced: boolean, language: string }).children(children)

Props

children	Children
fenced	optionalboolean
language	optionalstring