From a36d063da4f6b9f6ffd9dafee693fb8ad0e13e7f Mon Sep 17 00:00:00 2001 From: Tilman Vatteroth Date: Tue, 11 Apr 2023 17:32:03 +0200 Subject: [PATCH] fix: correct docs Signed-off-by: Tilman Vatteroth --- .../markdown-renderer/markdown-to-react/markdown-to-react.tsx | 3 ++- frontend/src/components/render-page/markdown-document.tsx | 3 +-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/frontend/src/components/markdown-renderer/markdown-to-react/markdown-to-react.tsx b/frontend/src/components/markdown-renderer/markdown-to-react/markdown-to-react.tsx index c39892f58..cdb8840f8 100644 --- a/frontend/src/components/markdown-renderer/markdown-to-react/markdown-to-react.tsx +++ b/frontend/src/components/markdown-renderer/markdown-to-react/markdown-to-react.tsx @@ -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 = ({ markdownContentLines, diff --git a/frontend/src/components/render-page/markdown-document.tsx b/frontend/src/components/render-page/markdown-document.tsx index 9429b4655..42774b0a4 100644 --- a/frontend/src/components/render-page/markdown-document.tsx +++ b/frontend/src/components/render-page/markdown-document.tsx @@ -28,7 +28,7 @@ export interface MarkdownDocumentProps extends RendererProps { } /** - * Renders a markdown document and handles scrolling, yaml metadata and a floating table of contents. + * Renders a Markdown document and handles scrolling, yaml metadata and a floating table of contents. * * @param additionalOuterContainerClasses Additional classes given to the outer container directly * @param additionalRendererClasses Additional classes given {@link DocumentMarkdownRenderer} directly @@ -40,7 +40,6 @@ export interface MarkdownDocumentProps extends RendererProps { * @param onHeightChange The callback to call if the height of the document changes * @param disableToc If the table of contents should be disabled. * @param newLinesAreBreaks Defines if the provided markdown content should treat new lines as breaks - * @see https://markdown-it.github.io/ */ export const MarkdownDocument: React.FC = ({ additionalOuterContainerClasses,