README.md

OfficeIMO.MarkdownRenderer.SamplePlugin - renderer plug-in example

OfficeIMO.MarkdownRenderer.SamplePlugin is a sample plug-in package for OfficeIMO.MarkdownRenderer. It shows how a third-party-style package can register visual features, HTML round-trip hints, and renderer options without changing the renderer core.

Install

dotnet add package OfficeIMO.MarkdownRenderer.SamplePlugin

Use it from a renderer host

using OfficeIMO.MarkdownRenderer;
using OfficeIMO.MarkdownRenderer.SamplePlugin;

var options = MarkdownRendererPresets.CreateStrict();
options.ApplyFeaturePack(SampleMarkdownRenderer.StatusPanelFeaturePack);

string html = MarkdownRenderer.RenderBodyHtml(markdownText, options);

Examples

Render a custom status panel fence

using OfficeIMO.MarkdownRenderer;
using OfficeIMO.MarkdownRenderer.SamplePlugin;

string markdown = """
# Deployment

```status-panel title="Production" status="green"
All deployment checks passed.
```
""";

var options = MarkdownRendererPresets.CreateStrict();
SampleMarkdownRenderer.ApplyStatusPanelFeaturePack(options);

string html = MarkdownRenderer.RenderBodyHtml(markdown, options);

Register matching HTML round-trip hints

using OfficeIMO.Markdown.Html;
using OfficeIMO.MarkdownRenderer.SamplePlugin;

var htmlOptions = HtmlToMarkdownOptions.CreateOfficeIMOProfile();
SampleMarkdownRenderer.ApplyHtmlRoundTripHints(htmlOptions);

string markdown = html.ToMarkdown(htmlOptions);

What it demonstrates

• Keeping host or product-specific visuals in a plug-in package.
• Registering renderer assets and Markdown document transforms.
• Carrying matching HTML round-trip hints for OfficeIMO.Markdown.Html.
• Preserving the generic renderer boundary.

Targets and license

• Targets: netstandard2.0, net8.0, net10.0.
• License: MIT.
• Repository: EvotecIT/OfficeIMO