Markdig Renderers¶

ConfluenceSynkMD uses Markdig as its Markdown parser and extends it with custom renderers that produce Confluence Storage Format (XHTML) instead of standard HTML.

How It Works¶

The ConfluenceRenderer is a custom IMarkdownRenderer that replaces Markdig's default HTML output. It registers individual renderers for each Markdown element type:

graph TD
    A[Markdown AST] --> B[ConfluenceRenderer]
    B --> C[HeadingRenderer]
    B --> D[CodeBlockRenderer]
    B --> E[LinkInlineRenderer]
    B --> F[ListRenderer]
    B --> G[TableRenderer]
    B --> H[... 13+ more]

Available Renderers¶

Adding a New Renderer¶

1. Create the renderer class in src/ConfluenceSynkMD/Markdig/Renderers/:

public class MyCustomRenderer : ConfluenceObjectRenderer<MyMarkdownObject>
{
    protected override void Write(
        ConfluenceRenderer renderer, MyMarkdownObject obj)
    {
        renderer.Write("<my-custom-output>");
        renderer.WriteChildren(obj);
        renderer.Write("</my-custom-output>");
    }
}

1. Register it in ConfluenceRenderer.cs:

ObjectRenderers.Add(new MyCustomRenderer());

1. Add tests in the test project

GitHub Alerts → Confluence Macros¶

A notable renderer feature is the conversion of GitHub-style alerts:

Use --use-panel to render all alerts as panel macros instead.