fix: correct docs

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2023-04-11 17:32:03 +02:00
parent d792fd3987
commit 7abbe79ec9
2 changed files with 3 additions and 3 deletions

View file

@ -21,12 +21,13 @@ export interface MarkdownToReactProps {
}
/**
* Renders Markdown code.
* Renders Markdown code as DOM
*
* @param markdownContentLines The Markdown code lines that should be rendered
* @param additionalMarkdownExtensions A list of {@link MarkdownRendererExtension markdown extensions} that should be used
* @param newlinesAreBreaks Defines if the alternative break mode of markdown it should be used
* @param allowHtml Defines if html is allowed in markdown
* @see https://markdown-it.github.io/
*/
export const MarkdownToReact: React.FC<MarkdownToReactProps> = ({
markdownContentLines,