Compare Markdown Documents in C#

Wordize for .NET is a professional solution for programmatic MD file comparison and difference detection. The Comparer class enables C# developers to identify content differences between two MD documents with the required level of detail and save comparison results to an output document. Differences between documents are displayed as revisions of the first MD document with author and modification time information.

Key Features:

Precise difference detection - the Comparer.Compare() method creates a result document with identified changes, including insertions, deletions, and Markdown markup modifications
Flexible MD comparison settings via the CompareOptions class: granular change tracking (by characters or words), text movement detection, case change ignoring, table exclusion, document fields, footnotes and endnotes, comments, text boxes, formatting options
Image format export capability - the Comparer.CompareToImages() method returns comparison results as an array of images
Support for both file and Stream object operations
Fluent API support for MD comparison operations through Comparer.ComparerContext and method chaining, enhancing C# code clarity

Use Cases:

Technical documentation version control - tracking changes between different versions of README files, API documentation, and developer guides in Markdown format
Collaborative documentation workflow - analyzing changes in project documents made by development team members
Blog and article change auditing - comparing draft and final versions of articles written in Markdown for web publication
Editorial content review - comparing MD document versions before and after editorial revisions for quality control and style compliance

Test the capabilities of programmatic MD document comparison in the interactive online demo presented on this page. Simply upload two MD files, run the comparison operation, and download results with identified differences in markup and content. The provided C# code snippet is ready for use in your .NET project.

Run code

Upload the first document

Upload the second document

Select output format from the list

using Wordize.Comparing;

Comparer.Compare("Input1.md", "Input2.md",
    "Output.md", "Author Name", DateTime.Now);

                            using Wordize.Comparing;

Comparer.Compare("{{input1}}", "{{input2}}",
    "{{output}}", "Author Name", DateTime.Now);

                            using Wordize.Comparing;
using Wordize.Saving;

var imageStreams = Comparer.CompareToImages("{{input1}}", "{{input2}}", 
    new ImageSaveOptions(SaveFormat.{{saveFormat}}), "Author Name", DateTime.Now);

foreach (var (stream, page) in imageStreams.Select((s, i) => (s, i)))
{
    using var _ = stream;
    stream.Position = 0;
    
    using var file = File.Create($"Output_{page + 1}.{{outputExt}}");
    stream.CopyTo(file);
}
            

                        Run code
			    

How to Compare MD in C#

1

Connect Wordize for .NET to your development project

Connect the Wordize SDK to your .NET project
2

Programmatically compare MD documents in C#

Call the Comparer.Compare() method, specifying two MD documents, a result file for saving the comparison output, and metadata (author and date) as arguments
3

Retrieve comparison results

Get the MD document comparison results