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

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

Features to Implement

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):

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:

Submitting Issues

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

Contributing

See CONTRIBUTING.md.

mitex (mitex-rs/mitex)

Searching Database…

638 ·GitHub
Mitex
Что это такое?MiTeX добавляет поддержку LaTeX в Typst: он разбирает LaTeX в абстрактное синтаксическое дерево, преобразует его в код Typst и вычисляет в содержимое Typst, так что можно писать математку в нотации LaTeX прямо в документах Typst.
Это пакет для Typst, утилита командной строки или сайт?И то, и другое, и третье. Он поставляется как пакет Typst, который импортируется в .typ-файлах, как консольная утилита mitex-cli и как веб-приложение на WASM, которое конвертирует формулы прямо в браузере.
Как пользоваться этим внутри документа Typst?Импортируйте пакет, а затем оберните свой LaTeX: mi рендерит строчные формулы, mitex(...) или mimath — выключные, mitext — текст LaTeX, а mitex-convert возвращает сконвертированный код Typst в виде строки.
Нужно ли ставить Rust или что-то ещё?Только CLI требует тулчейн Rust — через cargo install --git mitex-cli. Пакет для Typst работает через WASM внутри Typst, а веб-приложению не нужен ничего, кроме браузера.
Насколько хорошо поддерживается LaTeX?Математика покрыта хорошо: формулы, окружения aligned/matrix/cases, команды цвета, \ref и \label, а также пользовательские макросы \newcommand. Текстовый режим поддержан лишь на уровне черновика, а такие окружения, как algorithm, пока не реализованы.
Насколько он быстрый и компактный по сравнению с texmath?MiTeX весит около 185 КБ против 17 МБ у texmath. Конвертацию 32,5 тыс. формул из OI Wiki MiTeX WASM выполнил за 2,28 с, нативная x86-сборка — всего за 0,085 с, а texmath потребовалось около 109 с.
Что ещё запланировано в roadmap?Динамическая передача спецификаций команд в плагин, поддержка пакетов, чтобы набор команд можно было менять, и более развитый текстовый режим с окружениями figure, algorithm и description.
What are similar projects?typst, manimgx, liteparse, rendercv, CalcKernel, MathJax, MathModel, wasmtime
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
638
Updated
CommitOct 11Release0.2.7Apr 07
Age
2y
Commits · 90 Days