Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

MarkdownRenderer

OfficeIMO.MarkdownRenderer

Namespace
OfficeIMO.MarkdownRenderer
Assembly
OfficeIMO.MarkdownRenderer
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Renders Markdown to HTML suitable for WebView2/browser hosts, and provides a reusable shell page + an incremental update mechanism.

Inheritance

  • object
  • MarkdownRenderer

Methods

public static string BuildShellHtml(string? title = null, MarkdownRendererOptions? options = null) #

Builds a self-contained HTML document that preloads CSS and scripts once (Prism/Mermaid), and exposes a global updateContent(newBodyHtml) function for incremental updates.

Parameters

title string? = null optional
options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions? = null optional

Returns

string
public static string BuildUpdateScript(string bodyHtml) #

Returns a JavaScript snippet that calls updateContent(...) with a properly escaped string literal.

Parameters

bodyHtml string required

Returns

string
public static MarkdownDocument ParseDocument(string markdown, MarkdownRendererOptions? options = null, ICollection<MarkdownDocumentTransformDiagnostic>? diagnostics = null, ICollection<MarkdownRendererPreProcessorDiagnostic>? preProcessorDiagnostics = null) #

Parses Markdown using renderer preprocessing and renderer-owned AST transforms, returning the final MarkdownDocument that would be rendered to HTML.

Parameters

markdown string required
options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions? = null optional
diagnostics System.Collections.Generic.ICollection<OfficeIMO.Markdown.MarkdownDocumentTransformDiagnostic>? = null optional
preProcessorDiagnostics System.Collections.Generic.ICollection<OfficeIMO.MarkdownRenderer.MarkdownRendererPreProcessorDiagnostic>? = null optional

Returns

MarkdownDocument
public static MarkdownRendererParseResult ParseDocumentResult(string markdown, MarkdownRendererOptions? options = null) #

Parses Markdown using renderer preprocessing and renderer-owned AST transforms, returning the final document, original syntax tree, and diagnostics together.

Parameters

markdown string required
options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions? = null optional
public static MarkdownNativeDocument ParseNativeDocument(string markdown, MarkdownRendererOptions? options = null) #

Parses Markdown using the renderer-owned pipeline and returns the AST-backed native projection.

Parameters

markdown string required
options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions? = null optional

Returns

MarkdownNativeDocument
public static string RenderBodyHtml(string markdown, MarkdownRendererOptions? options = null) #

Parses Markdown using OfficeIMO.Markdown and returns an HTML fragment (typically an <article class="markdown-body"> wrapper). When Mermaid is enabled, Mermaid code blocks are annotated with hashes for incremental rendering.

Parameters

markdown string required
options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions? = null optional

Returns

string
public static string RenderChatBubbleBodyHtml(string markdown, ChatMessageRole role = Assistant, MarkdownRendererOptions? options = null) #

Convenience helper: renders Markdown then wraps the result in a chat bubble.

Parameters

markdown string required
role OfficeIMO.MarkdownRenderer.ChatMessageRole = Assistant optional
options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions? = null optional

Returns

string
public static string RenderChatBubbleUpdateScript(string markdown, ChatMessageRole role = Assistant, MarkdownRendererOptions? options = null) #

Convenience helper: renders Markdown as a chat bubble and returns an update script snippet.

Parameters

markdown string required
role OfficeIMO.MarkdownRenderer.ChatMessageRole = Assistant optional
options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions? = null optional

Returns

string
public static string RenderUpdateScript(string markdown, MarkdownRendererOptions? options = null) #

Convenience helper for hosts: renders Markdown to an HTML fragment and returns the JavaScript snippet that updates the shell (calls updateContent(...)).

Parameters

markdown string required
options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions? = null optional

Returns

string
public static string WrapAsChatBubble(string bodyHtml, ChatMessageRole role = Assistant) #

Wraps an existing HTML fragment in a chat "bubble" container (optional). This is purely a formatting helper: it does not change Markdown parsing rules.

Parameters

bodyHtml string required
role OfficeIMO.MarkdownRenderer.ChatMessageRole = Assistant optional

Returns

string