am-to-chtml v0.2.1
am-to-chtml
This MathJax wrapper converts AsciiMath (AM) to CompactHypertextMarkUpLanguage (CHTML). This package doesn't use any webworkers, webviews ; so It can be used for your NodeJS, React and React Native projects.
This project is still in its early development stages.
For any bugs, typos, errors, feel free to open an issue on the associated Github repository.
Installation
npm install am-to-chtml --save
Examples
JS (with the options
parameter)
const AMToCHTML = require("am-to-chtml");
const myAMEquation = "d/dxf(x)=lim_(h->0)(f(x+h)-f(x))/h";
const options = {
width: 1280,
ex: 8,
em: 16,
fontURL: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2"
};
const CHTMLEquation = AMToCHTML(myAMEquation, options); // returns <mjx-math class=" MJX-TEX"><mjx-mstyle><mjx-mfrac><mjx-frac> ...
TS (without the options
parameter)
import AMToCHTML from "am-to-chtml";
const myAMEquation = "d/dxf(x)=lim_(h->0)(f(x+h)-f(x))/h";
const CHTMLEquation = AMToCHTML(myAMEquation); // returns <mjx-math class=" MJX-TEX"><mjx-mstyle><mjx-mfrac><mjx-frac> ...
Documentation
AMToCHTML(equation, options)
: string The returned CompactHypertextMarkUpLanguage equation
equation
: string The AsciiMath equation
options
?: object The options of the retuned CHTML
width
?: number The width of container in pixels
ex
?: number The ex-size in pixels
em
?: number The em-size in pixels
fontURL
?: string The URL to use for web fonts
Notation
?: = optional parameter
Notes
Useful links
This wrapper is inspired by this project : https://github.com/mathjax/MathJax-demos-node/tree/master/direct.
Typescript
You DON'T have to install any types @types/am-to-chtml
.