@stihl-design-system/components/utils/render-documentation.d.ts

Welcome to the STIHL Design System react component library.

import { JSX } from 'react';
type DocumentationRenderOptions = {
    hideCodeExample?: boolean;
    hideControls?: boolean;
    isDocumentationAtTop?: boolean;
};
/**
 * Renders documentation from a markdown string.
 * @param documentation - The markdown string to render.
 * @returns A JSX.Element with the rendered documentation.
 */
export declare function renderDocumentation(documentation: string): JSX.Element;
/**
 * Renders documentation with specified rendering options.
 * @param options - Optional rendering options to customize the output.
 * @returns A JSX.Element with the rendered documentation.
 */
export declare function renderDocumentation(options?: DocumentationRenderOptions): JSX.Element;
/**
 * Renders documentation from a markdown string with specified rendering options.
 * @param documentation - Optional markdown string to render.
 * @param options - Optional rendering options to customize the output.
 * @returns A JSX.Element with the rendered documentation.
 */
export declare function renderDocumentation(documentation?: string, options?: DocumentationRenderOptions): JSX.Element;
export {};