Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

compromise-align

smart-replace plugin for nlp-compromise

readme

a plugin for compromise

npm install compromise-align
const nlp = require('compromise')
nlp.extend(require('compromise-align'))

let doc = nlp(myNovel)
let html = doc.htmlAlign('the #Adjective of times')
document.querySelector('#myId').innerHTML = html

generate html output to line-up matches in a text, for easy viewing.

Demo

Usage

in terms of CSS styling, it does most of the layout, and tags the middle text as .matchText. You can style it however you'd like.

the method returns html-strings by default, but the library uses Jason Miller's htm library so you can return React Components, or anything:

doc.htmlAlign(
  {},
  {
    bind: React.createElement,
  }
)

work-in-progress

MIT