Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 2.97 KB

README.md

File metadata and controls

82 lines (49 loc) · 2.97 KB
Raw

textdiffcore

Crossplatform diff engine for .net core

Build Status

How to use

Check out this blog post for a detailed write up.

Install the package

Package Manager:

PM> Install-Package textdiffcore -Version 1.0.3

.NET CLI

dotnet add package textdiffcore --version 1.0.3

Packet CLI

paket add textdiffcore --version 1.0.3

In your code...

using textdiffcore;
using textdiffcore.DiffOutputGenerators;
using textdiffcore.TextDiffEngine;


...
TextDiff diffobj = new TextDiff(new MyersDiff(), new HTMLDiffOutputGenerator("span", "style", "color:#003300;background-color:#ccff66;","color:#990000;background-color:#ffcc99;text-decoration:line-through;",""));

string oldText = "The quick brown fox jumps over the lazy dog";
string newText = "A quick cat jumps over the lazy sleeping dog";
string output =  diffobj.GenerateDiffOutput(oldText,newText);

output is: Output HTML

Which looks like this in a web browser: Output HTML after rendering

How to implement your own output engine or text comparison engine

TBA

License

This software is released under the MIT License

Notice

The classes within 'DiffMatchPatch.cs' is (C) 2018 The diff-match-patch Authors, it is used here under its Apache v2.0 License.

Found a bug?

If you've found a bug please file a new issue.

Making contributions

To propose a change, you first need to create a GitHub account.

Once you're signed in, you can browse through the folders above and choose the content you're looking for. You should then see the content in Markdown form. Click the Edit icon in the top-right corner to start editing the content.

The content is written in the Markdown format. There's a guide here on how to get started with it.

You can preview your changes using the tabs at the top of the editor.

When you're happy with your change, make sure to create a pull request for it using the options at the bottom of the page. You'll need to write a short description of the changes you've made.

A pull request is a proposal for a change to the content. Other people can comment on the change and make suggestions. When your change has been reviewed, it will be "merged" - and it will appear immediately in the published content.

Take a look at this guide on GitHub about pull requests.