Repository: nokodiff

A Ruby Gem to highlight additions, deletions and character level changes while preserving original HTML.

README

A Ruby Gem to highlight additions, deletions and character level changes while preserving original HTML.

It includes functionality to:

Compare two HTML fragments and output diffs with semantic HTML
Inline character differences highlighting using <strong> tagging
Blocks of added or removed content wrapped in aria labelled <ins> and <del> tags
Optional CSS for styling the visual differences

Install the gem:

gem install nokodiff

or add it to your Gemfile

gem "nokodiff"

In the controller:

require 'nokodiff'

before_html = < YOUR HTML >
after_html = < YOUR HTML >

@differ = Nokodiff.diff(before_html, after_html)

In the erb file:

<div>
  <%= @differ %>
</div>

In your application.scss file include:

@import "nokodiff";

This will include the styling for <del>, <ins> and <strong> tags to allow colour coding, highlighting and underlining of changes.

The gem is available as open source under the terms of the MIT License.