blaisewang / img2latex-mathpix

Mathpix has changed their billing policy and no longer has free monthly API requests. This repo is now archived and will not receive any updates for the foreseeable future.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Image2LaTeX

English | 中文

Codacy Badge Build Status Releases Downloads PRs Welcome License

Snip is an amazing app built by Mathpix to help you extract LaTeX, MathML, basic table, and text from documents. It gives you the first 50 snips for free (100 snips when you sign up with a .edu or .ac.uk domain email) every single month.

With the help of MathpixOCR API and this supplementary app, you can now make up to 1000 OCR requests per month for free.

Image2LaTeX is a personal side project that keeps only core functions of the Snip such as convert images to certain LaTeX equation formats and OCR. For other advanced functions and unlimited snips, subscribe to the Snip for $4.99 per month.

Features

See the features section on MathpixOCR website.

New Features

  • API Usage stats (for reference only).
  • New TSV OCR format for Microsoft Excel and more.
  • New MathML OCR format for Microsoft Word and more.
  • New multiple choice, paragraphs, basic table OCRs, and more.
  • HTTP proxy support for making OCR request.

Requirements

  • Your API keys in your MathpixOCR dashboard (different from the Mathpix account used in the Snip app)

Run

Enter your API keys (without single quotes) at the first launch of this app.

To change your API keys, macOS and Windows users will find the API Credentials tab in the Preferences menu item by clicking this app's menu bar icon.

Linux user can open the Preferences panel by right-clicking anywhere inside the application.

Note, this app will not send your API keys to others except for MathpixOCR API server (see OCRRequestHelper.java to learn how your API keys are used).

Usage

macOS

Run Image2LaTeX.app.

Windows

Run Image2LaTeX.exe.

Linux

Run Image2LaTeX at Image2LaTeX-linux/bin/ or with:

./Image2LaTeX

Use your operating system's default methods (or other tools) to take a screenshot of equations or text (Shift (⇧)-Control (⌃)-Command (⌘)-4 on macOS by default).

Then, press the Space key to preview the screenshot. Or, press the Return or Enter key to send the OCR request directly.

See demo section below.

Demo

demo

FAQ

Microsoft Word with MathML

To fix the brackets and parentheses around matrices or fractions, click the Professional option from the right-hand side dropdown menu of the equation.

Subscribe to new releases

See this article about watching and unwatching releases for a repository by GitHub.

Issues

Please first refer to the official API Docs about error types and the reported issue if you encountered an error.

Encountered an unreported issue 🤔

Welcome to open an issue with the bug or question label, but the time to fix non-vital bugs may not be guaranteed.

Contributions

Contributions are highly welcomed. Suggestions can be made through opening an issue with enhancement label. Pull Requests including bug fixes, new features, code style guidance, etc., will be reviewed as soon as possible.

Contributors ✨


Hao Xu

🤔

龚焱

🤔

BOB

🐛 ⚠️

YuiTH

🐛

Xyzhao

💻

edward9503

🐛

License

This code is distributed under the terms of the Apache License 2.0.

About

Mathpix has changed their billing policy and no longer has free monthly API requests. This repo is now archived and will not receive any updates for the foreseeable future.

License:Apache License 2.0


Languages

Language:Java 97.1%Language:Shell 2.9%