Comment Formula

Introduction

A VSCode extensions to preview LaTeX formulas within the lines of your editor.

Render Engine: MathJax

Feature

Usage

You are supposed to write formulas between $$ and $$.

Enable Highlight

[!IMPORTANT] TL;DR: Two ways to enable highlight:

1. Use MathJax Highlight. (Recommended)
2. Config scopes in User Settings;

Use MathJax Highlight

Every time updating the extension, a message will be shown in the corner to reload the editor for the changes to take effect.

Therefore, you can alternatively use MathJax Highlight with same highlight feature and lower update frequency. It enables highlight in source.c, source.cpp, source.java, source.python in default.

Config scopes in User Settings

Use the command Developer: Inspect Editor Tokens and Scopes to get the global scope of the language current file is using.

For example:

'source.c'
'source.cpp'
'source.java'
'source.python'

Note that suffixes of scopes aren't always the same as the languageId (e.g. javascript -> source.js).

The syntax highlight in VSCode can't be modified until the next opening of the editor. So every time changing the configuration, you need to reload the editor as prompted by the message shown in the corner.

Next, if you don't want to bold the code, set comment-formula.code to "".

So the best practice for default languages is shown below:

// Preferences: Open User Settings (JSON):
{
  "comment-formula.scopes": [
    "source.c",
    "source.cpp",
    "source.java",
    "source.python"
  ],
  "comment-formula.code": ""
}

Set this configuration in user settings rather than workspace settings, or every time you open a workspace with different languages, you will get a message to reload the editor for the changes to take effect.

Configurations

Feel free to new an issue if you encounter any problem or have any suggestion.

Reference

VSCode Iconify | MathJax | KaTeX | VSCode Markdown | LaTeX Workshop | VSCode Markdown Math

License

Code is under the MIT License.

Logo using carbon:function as an element is under the Apache License 2.0.

Fonts used in feature image are Dancing Script (for Before and After) under the Open Font License and Input (for code) under the Input Font License.

Support

If you find this project useful, please consider giving it a star on GitHub. Your support is greatly appreciated!