fix: correct docs

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>

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<MarkdownToReactProps> = ({
   markdownContentLines,

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<MarkdownDocumentProps> = ({
   additionalOuterContainerClasses,