A quick and easy diff generator with support for plaintext and formatted diffs of markdown.
Go to file
Adam Brown 9c18a2b73b remove generated files from repo 2016-12-28 16:45:45 -05:00
dist remove generated files from repo 2016-12-28 16:45:45 -05:00
src create prod version 2016-12-28 16:44:45 -05:00
test add support for markdown mode rendering 2016-12-14 01:30:09 -05:00
.babelrc start test suite for dubdiff engine 2016-12-09 18:01:59 -05:00
.gitignore create prod version 2016-12-28 16:44:45 -05:00
README.md initial server-side rendering, restructure source folder 2016-12-03 22:14:15 -05:00
TODO.md add semantic css local, begin implement markdown diff, etc. 2016-12-09 17:07:42 -05:00
package.json create prod version 2016-12-28 16:44:45 -05:00
webpack.config.js create prod version 2016-12-28 16:44:45 -05:00

README.md

dubdiff

A diff viewer for markdown-formatted and plaintext documents.

These diffs are intended for use in copy-editing. The diffs are performed word-by-word, similarly to how the GNU wdiff tool works. This produces a more meaningful diff for English-language editing.

The diff may be further processed in a way that is aware of markdown formatting. The resulting output attempts to show differences of copy within the final document format (rather than differences of format).

The markdown-sensitive processing of the wdiff comparison is at ..., for the curious.

Version 2

This is a complete rewrite of Dubdiff with:

  • simpler project architecture
  • client-side diffing engine and simplified server
  • server-side rendering
  • switch to React from Angular
  • clean up of diffing engine
  • goal of implementing a HTML diff viewer

Basically I'm rewriting it for fun.

Live Server

The tool is live at http://dubdiff.com, feel free to use it there.

Provisioning

You'll need node & npm. Then install dependencies with

npm install

To build and launch a dev server:

npm start
npm run server

To build and launch the distribution server:

npm run build:dist
npm run server:dist

Data is saved to a simple flat file db in the data folder. If this folder doesn't exist, create it.

mkdir data

Low-memory environments

On a low-memory machine, eg. a DigitalOcean 512MB instance, you will need to enable virtual memory. Use this guide:

How To Configure Virtual Memory (Swap File) on a VPS

Start on boot

To make the application start on boot, run the following:

pm2 start grunt --name dubdiff -- serve:dist
pm2 startup systemd
pm2 save

Digital Ocean: How To Set Up a Node.js Application for Production on Ubuntu 16.04