1 | # Mume with litvis
|
2 |
|
3 | [![Build Status](https://travis-ci.org/gicentre/mume-with-litvis.svg?branch=master)](https://travis-ci.org/gicentre/mume-with-litvis)
|
4 |
|
5 | This project is a fork of [`mume`](https://github.com/shd101wyy/mume), which is the cor library behind for [Markdown Preview Enhanced for Atom](https://atom.io/packages/markdown-preview-enhanced) and [Markdown Preview Enhanced for VSCode](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced#review-details).
|
6 | Most of the code in this fork is inherited from the upstream repository and is thus courtesy of [@shd101wyy](https://github.com/shd101wyy) and other [contributors](https://github.com/shd101wyy/mume/graphs/contributors) to `mume`.
|
7 |
|
8 | The fork produces an npm module called [`mume-with-litvis`](https://www.npmjs.com/package/mume-with-litvis), which enables _Literate Visualisation_ ([litvis](http://litvis.org/)) in rendered markdown previews.
|
9 |
|
10 | Litvis functionality has been designed and developed at [giCentre](https://www.gicentre.net/) by [Jo Wood](https://github.com/jwoLondon), [Alexander Kachkaev](https://github.com/kachkaev) and [Jason Dykes](https://github.com/jsndyks).
|
11 | This research was in part supported by the EU under the EC Grant Agreement No. FP7-IP-608142 to Project [VALCRI](http://valcri.org/).
|
12 |
|
13 | ## Setup
|
14 |
|
15 | - [for Atom users](https://github.com/gicentre/markdown-preview-enhanced-with-litvis)
|
16 | - [for VSCode users](https://github.com/gicentre/vscode-markdown-preview-enhanced-with-litvis)
|