Vscode Math To Image

📐 Render LaTeX math equations in any Markdown file!
Alternatives To Vscode Math To Image
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Bytemd3,7382424 days ago63July 21, 202238mitTypeScript
Hackable Markdown Editor and Viewer
Livebook3,5571an hour ago20July 13, 202224apache-2.0Elixir
Automate code & data workflows with interactive Elixir notebooks
a day ago44otherJava
Text editor - Notes & ToDo (for Android) - Markdown, todo.txt, plaintext, math, ..
Vscode Markdown2,594
8 days ago1October 27, 2018286mitTypeScript
Markdown All in One
4 months ago12February 02, 20222mitJavaScript
Self-rendering Markdown + LaTeX documents
Cocalc1,05534 hours ago192July 12, 20221,594otherTypeScript
CoCalc: Collaborative Calculation in the Cloud
a year ago42June 06, 20216mitJavaScript
LaTeX Math for Markdown inside of Visual Studio Code.
Marp Core609194a day ago79September 08, 20228mitTypeScript
The core of Marp converter
6 months ago7February 02, 2022mitJavaScript
Self-rendering and distributable mathematics chalkboards
3 months ago12mitHTML
advanced compilers
Alternatives To Vscode Math To Image
Select To Compare

Alternative Project Comparisons

Math » Image

📐 We can help you render LaTeX math equations in any Markdown file!

Azure DevOps builds (branch) Visual Studio Marketplace Visual Studio Marketplace Downloads Visual Studio Marketplace Rating (Stars)

This is a VS Code extension to help you convert a standard LaTeX math equation like $E=mc^2$ to an image like (remote) or a local SVG which can be embedded inside Markdown files or websites that doesn't support rendering LaTeX yet. (That's you GitHub!)

Read more about Math to Image here:

Table of Contents



There are two modes in which we will render your math equations in Markdown:

  • Locally (with MathJax and sourcing relative SVG), and...
  • Remotely (with GitHub's LaTeX rendering server).

Rendering remotely

This is actually a hack. GitHub won't render LaTeX equations inside normal places like GitHub README, but it can render them in Jupyter notebooks, so we took advantage of this feature, utilizing GitHub's equation rendering server to embed SVG equations in GitHub. (See here for details: A hack for showing LaTeX formulas in GitHub markdown.)

Basically we can convert a standard LaTeX math equation like the Gaussian Normal Distribution...

P(x) = \frac{1}{\sigma\sqrt{2\pi}} e^{\frac{-(x-\mu)^2}{2\sigma^2}}

... to a rendered image tag with the help of GitHub's math rendering server:

<div align="center"><img style="background: white;" src="https://render.githubusercontent.com/render/math?math=P(x)%20%3D%20%5Cfrac%7B1%7D%7B%5Csigma%5Csqrt%7B2%5Cpi%7D%7D%20e%5E%7B%5Cfrac%7B-(x-%5Cmu)%5E2%7D%7B2%5Csigma%5E2%7D%7D"></div>

In addition to GitHub's rendering server, we also newly added support for CodeCogs' rendering server:

<div align="center"><img style="background: white;" src="https://latex.codecogs.com/svg.latex?P(x)%20%3D%20%5Cfrac%7B1%7D%7B%5Csigma%5Csqrt%7B2%5Cpi%7D%7D%20e%5E%7B%5Cfrac%7B-(x-%5Cmu)%5E2%7D%7B2%5Csigma%5E2%7D%7D"></div>

Rendering locally

Not everywhere accept external SVGs. To circumvent this type of scenario, we can render math equations directly to local SVGs (with MathJax), and embed these local SVGs into our Markdown as a workaround.

We can convert the same LaTeX math equation:

P(x) = \frac{1}{\sigma\sqrt{2\pi}} e^{\frac{-(x-\mu)^2}{2\sigma^2}}

To a local SVG like: svg/e40qQ5G9jw.svg, which will be saved to a dedicate folder called svg, and sourced inside the Markdown file that requires math-embedding.

🌸 NOTE: There used to be a demo SVG here, but Visual Studio Marketplace won't allow us to add local SVGs inside their README.

If you are reading this on GitHub, you can see that both of these methods work when we need to add math equations to READMEs or other Markdown files on GitHub.

See examples for more math equation rendering scenarios, i.e, inline math, aligned environments...

Extension Settings

You can specify the path to save the locally rendered SVG image. The settings are self-explanatory.

  • vscode-math-to-image.svgSavePath:
    • Current file directory: Generated SVG files will be put in a folder under current file's directory.
    • Current workspace directory: Generated SVG files will be put in a folder under current workspace directory.
  • vscode-math-to-image.remoteRenderEngine:
    • GitHub: Equations will be rendered with GitHub's rendering engine remotely.
    • CodeCogs: Equations will be rendered with CodeCogs' rendering engine remotely.
  • vscode-math-to-image.inlineSvgStyle: Optional style for rendered inline SVG equations. Defaults to transform: translateY(0.1em); background: white;. Note: Not supported with Markdown-insertionType.
  • vscode-math-to-image.displaySvgStyle: Optional style for rendered display SVG equations. Defaults to background: white;. Note: Not supported with Markdown-insertionType.
  • vscode-math-to-image.insertionType: Choose whether to insert the rendered equations as HTML (default) or Markdown. Note that Markdown doesn't support styling.

Change Log

For version updates and bug fixes, please see: CHANGELOG.

📐 Math » Image © TeamMeow. Released under the MIT License.

Authored and maintained by TeamMeow members.

🦁 We build things that go "meow" · @GitHub · @Members

Popular Markdown Projects
Popular Mathematics Projects
Popular Data Formats Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Vscode Extension