From 294b245d887c544571244050cebeafd9c409b4cf Mon Sep 17 00:00:00 2001 From: simlarsen Date: Tue, 9 Jul 2024 11:44:50 +0000 Subject: [PATCH] OneUptime Copilot: Improve Comments on /App/FeatureSet/Docs/Utils/Render.ts --- App/FeatureSet/Docs/Utils/Render.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/App/FeatureSet/Docs/Utils/Render.ts b/App/FeatureSet/Docs/Utils/Render.ts index 567002b52c8..6b3bb0aeaf2 100644 --- a/App/FeatureSet/Docs/Utils/Render.ts +++ b/App/FeatureSet/Docs/Utils/Render.ts @@ -1,7 +1,11 @@ import Markdown, { MarkdownContentType } from "CommonServer/Types/Markdown"; +// This class is responsible for rendering markdown content to HTML export default class DocsRender { + + // Render markdown content to HTML and return the result as a promise public static async render(markdownContent: string): Promise { + // Use the Markdown library to convert markdown content to HTML return Markdown.convertToHTML(markdownContent, MarkdownContentType.Docs); } -} +} \ No newline at end of file