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-convertto convert LaTeX code into Typst code in string. - Use
mito render an inline LaTeX equation in Typst. - Use
mitex(numbering: none, supplement: auto, ..)ormimathto render a block LaTeX equation in Typst. - Use
mitextto 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.0": *
#assert.eq(mitex-convert("\alpha x"), "alpha x ")
Write inline equations like #mi("x") or #mi[y].
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 as a CLI Tool
Installation
Install it by cargo install mitex-cli or install 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
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.
- Coloring commands (
- Basic text mode support, you can use it to write LaTeX drafts.
-
\section,\textbf,\emph. - Inline and block math equations.
-
\ref,\eqrefand\label. -
itemizeandenumerateenvironments.
-
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 and description environments.
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!
Submitting Issues
If you find missing commands or bugs of MiTeX, please feel free to submit an issue here.
Contributing to MiTeX
Currently, MiTeX maintains following three parts of code:
- A TeX parser library written in Rust, see mitex-lexer and mitex-parser.
- A TeX to Typst converter library written in Rust, see mitex.
- A list of TeX packages and comamnds written in Typst, which then used by the typst package, see MiTeX Command Specification.
For a translation process, for example, we have:
\frac{1}{2}
===[parser]===> AST ===[converter]===>
#eval("$frac(1, 2)$", scope: (frac: (num, den) => $(num)/(den)$))
You can use the #mitex-convert() function to get the Typst Code generated from LaTeX Code.
Add missing TeX commands
Even if you don't know Rust at all, you can still add missing TeX commands to MiTeX by modifying specification files, since they are written in typst! You can open an issue to acquire the commands you want to add, or you can edit the files and submit a pull request.
In the future, we will provide the ability to customize TeX commands, which will make it easier for you to use the commands you create for yourself.
Develop the parser and the converter
See CONTRIBUTING.md.
12 Feb 19, 2023
2 Oct 19, 2022
62 Jan 5, 2023
11 Sep 4, 2023
9 Apr 18, 2023
4 Jun 7, 2023
91 Jul 4, 2023
18 Dec 16, 2023
3 Feb 15, 2024
29 Apr 25, 2023
7 Sep 21, 2023
3 Nov 15, 2023
5 May 11, 2023
6 Mar 1, 2024
3 Dec 2, 2022
211 Dec 20, 2022
2 Mar 29, 2022
429 Apr 15, 2023
20 Mar 7, 2023