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: about 2 months ago
JSON representation

A web component for easy math input

• Host: GitHub
• URL: https://github.com/arnog/mathlive
• Owner: arnog
• License: mit
• Created: 2017-06-12T22:20:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T00:34:18.000Z (4 months ago)
• Last Synced: 2024-05-22T08:22:54.250Z (4 months ago)
• Topics: custom-elements, editor, javascript, math, mathfield, typescript, webcomponent
• Language: TypeScript
• Homepage: https://cortexjs.io/mathlive
• Size: 40.9 MB
• Stars: 1,224
• Watchers: 21
• Forks: 254
• Open Issues: 79
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Authors: AUTHORS

Awesome Lists containing this project

• awesomeLibrary - mathlive - A web component for easy math input (语言资源库 / typescript)
• awesome-web-cn - mathlive - 针对数学公式的 web component ，你可以通过使用这个库很容易地在你的项目中展示数学公式或者创建可交互的数学公式的 input (Uncategorized / Uncategorized)

README

        


    



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!



    

        

            

        

        

            

        

    

    

        

            

        

    

## 🚀 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).

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