Quick Start

Install the Library

# Install from NuGet
dotnet add package Docxodus

Using as a Library

using Docxodus;
// Compare documents
var original = new WmlDocument("original.docx");
var modified = new WmlDocument("modified.docx");
var settings = new WmlComparerSettings
{
 AuthorForRevisions = "Redline",
 DetailThreshold = 0
};
var result = WmlComparer.Compare(original, modified, settings);
// Get list of revisions (with move detection)
var revisions = WmlComparer.GetRevisions(result, settings);
foreach (var rev in revisions)
{
 if (rev.RevisionType == WmlComparer.WmlComparerRevisionType.Moved)
 Console.WriteLine($"Moved (group {rev.MoveGroupId}): {rev.Text}");
 else
 Console.WriteLine($"{rev.RevisionType}: {rev.Text}");
}
// Save the redlined document
result.SaveAs("redline.docx");

CLI Tools

Redline (Document Comparison)

# Install globally
dotnet tool install -g Redline
# Usage
redline original.docx modified.docx output.docx
# With custom author tag
redline original.docx modified.docx output.docx --author="Legal Review"

docx2html (HTML Conversion)

# Install globally
dotnet tool install -g Docx2Html
# Basic conversion
docx2html document.docx
# Specify output file
docx2html document.docx output.html
# Extract images to files instead of embedding as base64
docx2html document.docx --extract-images
# Use inline styles instead of CSS classes
docx2html document.docx --inline-styles

Download Standalone Binaries

Build from Source

# Clone the repository
git clone https://github.com/JSv4/Docxodus.git
cd Docxodus
# Build
dotnet build Docxodus.sln
# Run the CLI
dotnet run --project tools/redline/redline.csproj -- --help

Testing

.NET Unit Tests

# Run all tests (~1,100 tests)
dotnet test Docxodus.Tests/Docxodus.Tests.csproj
# Run specific test by name
dotnet test --filter "FullyQualifiedName~WC001"
# Run tests for a specific class
dotnet test --filter "FullyQualifiedName~WmlComparerTests"

npm/WASM Browser Tests (Playwright)

# Need to be in npm subdirectory
cd npm
# Install dependencies (first time only)
npm install
npx playwright install chromium
# Build WASM and TypeScript (required before tests)
npm run build
# Run all Playwright tests (~62 tests)
npm test
# Run specific test by name pattern
npx playwright test --grep "Document Structure"
# Run tests with browser visible
npx playwright test --headed
# TypeScript type checking
npx tsc --noEmit

Features

Browser/JavaScript Usage (npm)

npm install docxodus

import {
 initialize,
 convertDocxToHtml,
 compareDocuments,
 getRevisions,
 getDocumentMetadata,
 isMove,
 isMoveSource,
 isFormatChange,
 findMovePair,
 CommentRenderMode,
 PaginationMode
} from 'docxodus';
await initialize();
// Convert DOCX to HTML with comments and pagination
const html = await convertDocxToHtml(docxFile, {
 commentRenderMode: CommentRenderMode.EndnoteStyle,
 paginationMode: PaginationMode.Paginated,
 renderHeadersAndFooters: true
});
// Compare two documents
const redlinedDocx = await compareDocuments(originalFile, modifiedFile);
// Get revisions with move and format change detection
const revisions = await getRevisions(redlinedDocx);
for (const rev of revisions) {
 if (isMove(rev)) {
 const pair = findMovePair(rev, revisions);
 if (isMoveSource(rev)) {
 console.log(`Content moved from: "${rev.text}" to: "${pair?.text}"`);
 }
 } else if (isFormatChange(rev)) {
 console.log(`Format changed: ${rev.formatChange?.changedPropertyNames?.join(', ')}`);
 }
}
// Get document metadata for lazy loading
const metadata = await getDocumentMetadata(docxFile);
console.log(`${metadata.totalParagraphs} paragraphs, ${metadata.estimatedPageCount} pages`);

Requirements

License