inlinelatex2readme

Convert Latex Fomular to Inline Snippet for Github Readme File.

✏️  Usage

---

1. Select the latex code block which you want to convert to inline fomular.

2. Right-click on the selected block and select Convert Latex Formular To Markdown Snippet from the drop-down menus that appear.

3. Conversion is completed as follows.

🌱  How Does the Plugin Works?

---

Github/markup currently does not officially support the Inline equation. Therefore, this plugin is designed to help users conveniently insert math formulas in an inline manner when writing Github README files.

Currently, there are various ways to insert Inline Formular into the Github README file (using render.githubusercontent.com, projects such as readme2tex). However, these methods are rendered in black text color without background color. Therefore, the Inline formular created by the above methods() has a disadvantage of poor readability in Github Dark-mode.

inlinelatex2readme solves this problem by utilizing Google Chart API that supports TeX language and user defined text/background color. This extension properly encodes the text selected by the user and converts it into an html tag snippet as shown in the following example.

• Example Fomular 1:

  <!-- E = mc^2 -->
  <img src="https://chart.apis.google.com/chart?cht=tx&chl=E%5C%20%3D%5C%20mc%5E2" />

• Example Fomular 2:

  <!-- a \equiv r \bmod c -->
  <img src="https://chart.apis.google.com/chart?cht=tx&chl=a%5C%20%5Cequiv%5C%20r%5C%20%5Cbmod%5C%20c" />

⏳  Release Notes

---

0.1.x

• 0.1.3: Update Fomular Revert Function .

• 0.1.2: Created a Github Action CI/CD pipeline for continuous deployment to the vscode extension marketplace.

• 0.1.1: Add Unit Test Logic.

• 0.1.0

  • Fix bug for Issue #1: An unwanted newline character is included in the generated inline formula link snippet.

0.0.x

• 0.0.1: Initial release of inline latex snippet generator for github readme file.