https://github.com/i10416/latex2unicode
convert latex to unicode in JVM, JavaScript and native
https://github.com/i10416/latex2unicode
latex scala scalajs web
Last synced: 3 months ago
JSON representation
convert latex to unicode in JVM, JavaScript and native
- Host: GitHub
- URL: https://github.com/i10416/latex2unicode
- Owner: i10416
- License: apache-2.0
- Created: 2022-04-06T04:40:20.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-24T11:14:20.000Z (over 3 years ago)
- Last Synced: 2025-01-12T22:43:56.386Z (over 1 year ago)
- Topics: latex, scala, scalajs, web
- Language: Scala
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LaTeX2Unicode
LaTeX2Unicode translates LaTeX markup to human readable Unicode when possible. Here's an online demo that can be conveniently used to type in special characters. (demo source)
Basic math notations are supported. For instance:
```
\because \t{AB} + \t{BC} \neq \t{AC}
\therefore \iint\sqrt[4]{\xi^{\theta+1}} - \frac 38 \le
\Sigma \zeta_i \\
\therefore \exists{x}\forall{y} x \in \^A
```
is converted to
> ∵ A͡B + B͡C ≠ A͡C ∴ ∬∜ξ̅ᶿ̅⁺̅¹̅ - ⅜ ≤ Σ ζᵢ
> ∴ ∃x∀y x ∈ Â
Hundreds of other symbols and special characters are supported, too. For example, `\spadesuit`, `\aleph`, `\OE`, `\downdownarrows` and `\o` are translated to `♠`, `ℵ`, `Œ`, `⇊`, `ø`, respectively.
Some font styles are supported, too. For instance:
```
\textbb{Black Board Bold}, \textfrak{Fraktur},
{\bf Bold Face}, {\cal Calligraphic}, {\it Italic},
{\tt Monospace}
```
is translated to
> 𝔹𝕝𝕒𝕔𝕜 𝔹𝕠𝕒𝕣𝕕 𝔹𝕠𝕝𝕕, 𝔉𝔯𝔞𝔨𝔱𝔲𝔯, 𝐁𝐨𝐥𝐝 𝐅𝐚𝐜𝐞, 𝓒𝓪𝓵𝓵𝓲𝓰𝓻𝓪𝓹𝓱𝓲𝓬, 𝐼𝑡𝑎𝑙𝑖𝑐, 𝙼𝚘𝚗𝚘𝚜𝚙𝚊𝚌𝚎
# Using as Scala / Java Library
LaTeX2Unicode is written in Scala, thus can serve as a 3rd party library in any JVM, JS or native application that needs to extract information from LaTeX texts (e.g. BibTeX).
## Simple Conversion
For simple conversion without configuration, which works fine in most cases, one call to a static method and you're done.
In Scala:
```scala
import dev.i10416.latex2unicode._
val latex = "\\ss^2 + \\alpha_3 \n \\div \\frac{1}{3} = \\sqrt[3]{123}"
val unicode = LaTeX2Unicode.convert(latex)
println(unicode)
```
In Java:
```java
import dev.i10416.latex2unicode.LaTeX2Unicode;
String latex = "\\ss^2 + \\alpha_3 \n \\div \\frac{1}{3} = \\sqrt[3]{123}"
String unicode = LaTeX2Unicode.convert(latex)
System.out.println(unicode);
```
## SBT Dependency
or add the following to your `build.sbt` file if you use sbt 0.11+:
```scala
libraryDependencies += "dev.i10416" %% "latex2unicode" % "0.0.1"
```
# Credits
`dev.i10416.Latex2unicode` is inspired by two similar projects, [latex-to-unicode by ypsu](https://github.com/ypsu/latex-to-unicode) \(written in Python\) and [latex-to-unicode by vikhyat](https://github.com/vikhyat/latex-to-unicode) \(written in Ruby\).
`dev.i10416.Latex2unicode` is built on [cats-parse](https://github.com/typelevel/cats-parse).
# Licence
Apache License Version 2.0