Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arnog/mathlive

A web component for easy math input
https://github.com/arnog/mathlive

custom-elements editor javascript math mathfield typescript webcomponent

Last synced: 10 days ago
JSON representation

A web component for easy math input

Awesome Lists containing this project

README 

        


    math live




MathLive


A Web Component for Math Input



[![Maintenance](https://img.shields.io/maintenance/yes/2024.svg)]()

[![GitHub license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://raw.githubusercontent.com/arnog/mathlive/master/LICENSE.txt)



MathLive is a powerful web component that provides an easy-to-use interface for

editing math formulas.



With over 800 **built-in LaTeX commands**, MathLive renders beautiful,

**TeX-quality typesetting**.



It's designed for **mobile devices** with an extensive set of virtual keyboards

for math input, and is compatible with screen readers, including custom

math-to-speech support for improved accessibility.



MathLive outputs to LaTeX, MathML, ASCIIMath, and MathJSON formats, making it

incredibly versatile.



And the best part? It's easy to customize to your needs!






    

        

            The popover panel

        

        

            A Virtual Keyboard

        

    

    

        

            The Loop Equation

        

    



## 🚀 Getting Started



Using MathLive is easy! Simply add a `` tag to your page. It

initializes automatically and works just like a `` or ``

element. You can manipulate the mathfield using methods of the element and

listen for events to be notified when its internal state changes.



`npm install mathlive`



```javascript

import 'mathlive';

```



```html



  

    f(x)=

  



```



You can also add it using CDN



```html



    



```



Check documentation for [React](https://cortexjs.io/mathlive/guides/react/) and

[interaction with Mathfield](https://cortexjs.io/mathlive/guides/interacting/).



## 📖 Documentation



MathLive has an extensive set of documentation to help you get started,

including guides on interacting with a mathfield, customizing it, executing

commands, defining custom LaTeX macros, managing inline and keyboard shortcuts,

controlling speech output, and displaying static math formulas. You can find all

of these guides on the [CortexJS.io website](https://cortexjs.io/mathlive/).



In addition to the guides, you can also find reference documentation of the

MathLive API on the [MathLive SDK page](https://cortexjs.io/docs/mathlive).



## FAQ



**Q:** When is the next release?



MathLive follows a semi-annual release cycle, with major releases typically

scheduled for June and January. These may be followed by patch releases to

address any issues that arise shortly after deployment. Additionally, an

out-of-band release can be made if requested by a sponsor or if a community

member submits a pull request and requests a release to include their

contribution.



## ⋯ 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
  




## 💬 Contact Us



- Chat with the

  [CortexJS Assistant](https://chat.openai.com/g/g-8YgEfR7ig-cortexjs-assistant)

- Join our [Discord server](https://discord.gg/yhmvVeJ4Hd)

- Drop a line to [[email protected]]([email protected])



## 📃 License



This project is licensed under the [MIT License](LICENSE.txt).