spx-katex-wrapper

**NOTE: This library is a direct replacement for the old library spx-katex
which was a fork of katex. The hope is that it will be easier to maintain
this wrapper than the original fork.

spx-katex-wrapper is a Sparx specific wrapper around the math rendering
library katex. The wrapper does some pre-processing on the math and adds
some convenience methods that we can share between applications.

Install

spx-katex-wrapper is a publicly published library and can be added to a
project with yarn add spx-katex-wrapper.

Usage

A basic React usage example:
``
import { renderMixedTextToString } from 'spx-katex-wrapper';

htmlToRender = (
dangerouslySetInnerHTML={{ __html: renderMixedTextToString(text, false) }}
/>
)
`

Development


If you need to make changes to spx-katex-wrapper then it is easier to install
it from a file path rather than installing the version published to NPM. You can
do this either by editing your application's package.json file or by
uninstalling the published dependency and installing the local version.

NOTE: The path to the local version may vary.

$3

Using published version:
`json
"spx-katex-wrapper": "^1.0.6",
`

Using local version:
`json
"spx-katex-wrapper": "file://../../jspackages/spx-katex-wrapper",
`

$3


`bash
yarn remove spx-katex-wrapper
yarn add spx-katex-wrapper
`

Updating

If you have made a change to spx-katex-wrapper and want to publish the changes then do
the following:

1) Update the version and publish the changes using yarn version --no-git-tag-version.
2) Then run npm publish, you will need to be Sam E or Tom K for this to work and you will need to have logged in
with npm login. TODO: Make this slicker.



Build versions

There are two built versions: commonjs and iife. The commonjs is the default version and will be
used if you use yarn to install it and then import it using import or require. The iife` version
can be used as a standalone install as it is bundled with all its dependencies.