# MarkdownRenderer

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

Class 

`OfficeIMO.MarkdownRenderer`

**Namespace**

`OfficeIMO.MarkdownRenderer`

**Assembly**

`OfficeIMO.MarkdownRenderer`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[MarkdownRenderer.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.cs#L19)

**Modifiers**

static

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

## Inheritance

- object
- MarkdownRenderer

Filter members 

Show inherited

## Methods

`public static string BuildShellHtml(string? title = null, MarkdownRendererOptions? options = null)` [#](#method-buildshellhtml-string-officeimo-markdownrenderer-markdownrendereroptions)

[MarkdownRenderer.Shell.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.Shell.cs#L27)

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)` [#](#method-buildupdatescript-string)

[MarkdownRenderer.Shell.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.Shell.cs#L80)

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)` [#](#member-6349fad512f36f09157cd86d)

[MarkdownRenderer.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.cs#L19)

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)` [#](#method-parsedocumentresult-string-officeimo-markdownrenderer-markdownrendereroptions)

[MarkdownRenderer.cs:44](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.cs#L44)

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**

Returns

`MarkdownRendererParseResult`

`public static MarkdownNativeDocument ParseNativeDocument(string markdown, MarkdownRendererOptions? options = null)` [#](#method-parsenativedocument-string-officeimo-markdownrenderer-markdownrendereroptions)

[MarkdownRenderer.cs:101](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.cs#L101)

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)` [#](#method-renderbodyhtml-string-officeimo-markdownrenderer-markdownrendereroptions)

[MarkdownRenderer.cs:123](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.cs#L123)

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)` [#](#method-renderchatbubblebodyhtml-string-officeimo-markdownrenderer-chatmessagerole-officeimo-markdownrenderer-markdownrendereroptions)

[MarkdownRenderer.Shell.cs:112](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.Shell.cs#L112)

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)` [#](#method-renderchatbubbleupdatescript-string-officeimo-markdownrenderer-chatmessagerole-officeimo-markdownrenderer-markdownrendereroptions)

[MarkdownRenderer.Shell.cs:120](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.Shell.cs#L120)

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)` [#](#method-renderupdatescript-string-officeimo-markdownrenderer-markdownrendereroptions)

[MarkdownRenderer.Shell.cs:88](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.Shell.cs#L88)

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)` [#](#method-wrapaschatbubble-string-officeimo-markdownrenderer-chatmessagerole)

[MarkdownRenderer.Shell.cs:97](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownRenderer.Shell.cs#L97)

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`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:FE1B8E0E70F9F09C7914B281808F8206907702EEE157C432195FD7E875A87423 -->
