Note: This repository has been archived

This project was developed under a previous phase of the Yale Digital Humanities Lab. Now a part of Yale Library’s Computational Methods and Data department, the Lab no longer includes this project in its scope of work. As such, it will receive no further updates.

Variant Viewer

Display line-level variants across print/manuscript editions

Variant Viewer is a minimal Jekyll framework for displaying line-level textual variants across multiple editions of a print or manuscript document. Using this framework, scholars can help readers and students understand the ways in which historical documents changed over time.

To use the variant viewer for a project, please consult the quickstart section below.

Quickstart

To run the variant viewer locally on your machine, you will need to install git and ruby on your machine. Once those are installed, you can run:

# clone the source code
git clone https://github.com/YaleDHLab/variant-viewer

# change directories into the source code repository
cd variant-viewer

# install the application dependencies
bundle install

# start the application server
jekyll serve

If this all goes well, you should be able to navigate to localhost:4000/variant-viewer/ in a web browser to see the source code in action.

Using custom data

The data for this application is defined in JSON files witin the _data directory. Please see the Wiki for descriptions of the data schemas of these files.