mitex README

The project's README from github.com/mitex-rs/mitex. As one markdown file: README.md.

MiTeX

LaTeX support for Typst, powered by Rust and WASM.

MiTeX processes LaTeX code into an abstract syntax tree (AST). Then it transforms the AST into Typst code and evaluates code into Typst content by eval function.

MiTeX has been proved to be practical on a large project. It has already correctly converted 32.5k equations from OI Wiki. Compared to texmath, MiTeX has a better display effect and performance in that wiki project. It is also more easy to use, since importing MiTeX to Typst is just one line of code, while texmath is an external program.

In addition, MiTeX is not only SMALL but also FAST! MiTeX has a size of just about 185 KB, comparing that texmath has a size of 17 MB. A not strict but intuitive comparison is shown below. To convert 32.5k equations from OI Wiki, texmath takes about 109s, while MiTeX WASM takes only 2.28s and MiTeX x86 takes merely 0.085s.

Thanks to @Myriad-Dreamin, he completed the most complex development work: developing the parser for generating AST.

MiTeX as a Typst Package

Use mitex-convert to convert LaTeX code into Typst code in string.
Use mi to render an inline LaTeX equation in Typst.
Use mitex(numbering: none, supplement: auto, ..) or mimath to render a block LaTeX equation in Typst.
Use mitext to render a LaTeX text in Typst.

PS: #set math.equation(numbering: "(1)") is also valid for MiTeX.

Following is a simple example of using MiTeX in Typst:

#import "@preview/mitex:0.2.7": *

Write inline equations like #mi(`x`).

Also block equations (this case is from #text(blue.lighten(20%), link("https://katex.org/")[katex.org])):

#mitex(`
  \newcommand{\f}[2]{#1f(#2)}
  \f\relax{x} = \int_{-\infty}^\infty
    \f\hat\xi\,e^{2 \pi i \xi x}
    \,d\xi
`)

We also support text mode (in development):

#mitext(`
  \iftypst
    #set math.equation(numbering: "(1)", supplement: "equation")
  \fi

  \section{Title}

  A \textbf{strong} text, a \emph{emph} text and inline equation $x + y$.

  Also block \eqref{eq:pythagoras}.

  \begin{equation}
    a^2 + b^2 = c^2 \label{eq:pythagoras}
  \end{equation}
`)

MiTeX example showing LaTeX equations rendered in Typst

MiTeX as a CLI Tool

Installation

Install the latest nightly version by cargo install --git https://github.com/mitex-rs/mitex mitex-cli.

Usage

mitex compile main.tex
# or (same as above)
mitex compile main.tex mitex.typ

MiTeX as a Web App

MiTeX Online Math Converter

We can convert LaTeX equations to Typst equations in web by wasm. https://mitex-rs.github.io/mitex/

Underleaf

We made a proof of concept online tex editor to show our conversion speed in text mode. The PoC loads files from a git repository and then runs typst compile in browser. As you see, each keystroking get response in preview quickly.

https://mitex-rs.github.io/mitex/tools/underleaf.html

https://github.com/mitex-rs/mitex/assets/34951714/0ce77a2c-0a7d-445f-b26d-e139f3038f83

Implemented Features

User-defined TeX (macro) commands, such as \newcommand{\mysym}{\alpha}.
LaTeX equations support.
- Coloring commands (\color{red} text, \textcolor{red}{text}).
- Support for various environments, such as aligned, matrix, cases.
Basic text mode support, you can use it to write LaTeX drafts.
- \section, \textbf, \emph.
- Inline and block math equations.
- \ref, \eqref and \label.
- itemize and enumerate environments.
- figure, table and tabular environments.

Features to Implement

Pass command specification to MiTeX plugin dynamically. With that you can define a typst function let myop(it) = op(upright(it)) and then use it by \myop{it}.
Package support, which means that you can change set of commands by telling MiTeX to use a list of packages.
Better text mode support, such as figure, algorithm and description environments.

To achieve the latter two goals, we need a well-structured architecture for the text mode, along with intricate work. Currently, we don't have very clear ideas yet. If you are willing to contribute by discussing in the issues or even submitting pull requests, your contribution is highly welcome.

Differences between MiTeX and other solutions

MiTeX has different objectives compared to texmath (a.k.a. pandoc):

MiTeX focuses on rendering LaTeX content correctly within Typst, leveraging the powerful programming capabilities of WASM and typst to achieve results that are essentially consistent with LaTeX display.
texmath aims to be general-purpose converters and generate strings that are more human-readable.

For example, MiTeX transforms \frac{1}{2}_3 into frac(1, 2)_3, while texmath converts it into 1 / 2_3. The latter's display is not entirely correct, whereas the former ensures consistency in display.

Another example is that MiTeX transforms (\frac{1}{2}) into \(frac(1, 2)\) instead of (frac(1, 2)), avoiding the use of automatic Left/Right to achieve consistency with LaTeX rendering.

Certainly, the greatest advantage is that you can directly write LaTeX content in Typst without the need for manual conversion!

Adding new commands

There are two kinds of commands to add:

Commonly used commands: If there are some builtin or commonly used commands missing in MiTeX, you can submit an issue or contribute them according to Adding missing TeX commands.

Special commands (Preambles): If you want to add some special commands (preambles) for your own use, you can define them by \newcommand or \newenvironment and override the mitex function in your. Example:

#let mitex = (content, ..args) => mitex.with(..args)({
  ```tex
  \newcommand{\f}[2]{#1f(#2)}
  ```.text
  content.text
})

And use them in your Typst code:

#show raw.where(lang: "mitex"): mitex
```mitex
\f\relax{x} = \int_{-\infty}^\infty
  \f\hat\xi\,e^{2 \pi i \xi x}
  \,d\xi
```

Submitting Issues

If you find missing commands or bugs of MiTeX, please feel free to submit an issue here.

Contributing

See CONTRIBUTING.md.

Searching Database…

633 ·GitHub

What is this?

MiTeX brings LaTeX support to Typst: it parses LaTeX into an abstract syntax tree, converts it into Typst code, and evaluates it into Typst content, so you can write LaTeX math directly in Typst documents.

Is it a Typst package, a CLI tool, or a website?

All three. It ships as a Typst package you import in .typ files, as a mitex-cli command-line tool, and as a WASM-powered web app that converts equations in the browser.

How do I use it inside a Typst document?

Import the package, then wrap your LaTeX: mi renders inline equations, mitex(...) or mimath renders block equations, mitext renders LaTeX text, and mitex-convert returns the converted Typst code as a string.

Do I need to install Rust or anything else to use it?

Only the CLI needs a Rust toolchain, via cargo install --git mitex-cli. The Typst package runs through WASM inside Typst, and the web app needs nothing but a browser.

How much LaTeX does it actually support?

Math is well covered: equations, aligned/matrix/cases environments, coloring commands, \ref and \label, and user-defined \newcommand macros. Text mode is basic draft-level support, and environments like algorithm are still unimplemented.

How fast and small is it compared to texmath?

MiTeX is about 185 KB versus texmath's 17 MB. Converting 32.5k equations from OI Wiki took MiTeX WASM 2.28s and the native x86 build just 0.085s, while texmath needed about 109s.

What is still on the roadmap?

Dynamically passing command specifications to the plugin, package support so the command set can be changed, and richer text mode with figure, algorithm and description environments.

What are similar projects?

typst, liteparse, rendercv, CalcKernel, MathJax, MathModel, wasmtime, pandoc

Which topics is it in?

typst, typesetting, tex, math, converter, latex, mathematics, parser, lightweight, high-performance, wasm, cli-tool

Creator: mitex-rs
Size: 1 MB
Stars: 633
Updated: CommitOct 11 Release0.2.7Apr 07
Age: 2y
Commits · 90 Days