nagwa-mathlive

Nagwa MathLive

A Web Component for Math Input

Extending the original mathlive to support Arabic inputs and editable chemistry

• A Web Component, easy to integrate in your project, regardless of the framework you use, or even if you just use plain JavaScript
• Edit math formulas with an easy to use interface
• Beautiful, TeX-quality typesetting: over 800 LaTeX commands built-in
• Designed for mobile devices with an extensive set of virtual keyboards for math input
• Compatible with screen readers, and includes custom math-to-speech support for improved accessibility
• Output to LaTeX, MathML and MathJSON (Abstract Syntax Tree) formats
• And it is easy to customize to your needs!

Documentation

Quick Start

Quick introduction to using MathLive in your project

Interact with a mathfield

Receive input and change the value of a mathfield

Customize a mathfield

Adapt the behavior and appearance of a mathfield to your needs

Execute commands

Send editing commands to a mathfield

Define custom Latex macros

Extend the Latex commands supported

Manage inline and keyboard shortcuts

Add or modify editing keyboard shortcuts

Control speech output

A mathfield can provide speech feedback to interact with it.

Display static math formulas

Display non-editable math formulas in your page

Define custom virtual keyboards

Customize or create new virtual (on-screen) keyboards

---

Getting Started

Everything you need to integrate the MathLive library to your project

MathLive SDK

Reference documentation of the MathLive API

Related Projects

MathJSON (on GitHub)

A lightweight data interchange format for mathematical notation.

Compute Engine (on GitHub)

The CortexJS Compute Engine performs calculations on MathJSON expressions

Cortex (on GitHub)

Cortex is a programming language for scientific computing

Release Steps

1. Update version in packages.json

2. create a .md file with version name inside CHANGELOG folder, like the follwing: v0.70.13.md (v is a must)

3. Add version name as a header in the newly created .md file, like this:

   ## [0.70.13]
   

4. Type changes in the newely created changelog file

5. mention created file in CHANGELOG.md -which is located in the root directory- like the following:

   ## [0.70.13]
   
   [v0.70.13.md](./CHANGELOG/v0.70.13.md)
   

6. run npm i in terminal, to update package.lock

7. push changes

8. run npm publish in terminal (You don't have to build production before publishing, since the "prepare" script handles it)

9. create tag with version name on gitlab, like this: v0.70.13. (v is a must)

10. wait for Jenkins to finish, can be viewed here: jenkins-beta.nagwa.com

License

This project is licensed under the MIT License.