Support \gdef (macros) in KaTeX #426

elbaro · 2019-04-23T08:02:12Z

What is the problem?

Katex provides \gdef, which defines a global macro. This plugin seems not supporting \gdef.

How can I reproduce it?

$$
\gdef\plim{\operatorname{plim}}
\plim asdf
$$

$$
\plim asdf
$$

The second macro does not render.

The text was updated successfully, but these errors were encountered:

upupming · 2019-04-23T08:10:06Z

All supported functions can be found at https://katex.org/docs/supported.html, you may need to report it to KaTeX.

…

On Tue, Apr 23, 2019, 4:02 PM elbaro ***@***.***> wrote: What is the problem? \gdef defines a global macro. This plugin seems not supporting \gdef. How can I reproduce it? $$ \gdef\plim{\operatorname{plim}} \plim asdf $$ $$ \plim asdf $$ The second macro does not render. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#426>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AF4YPBFHEWAY2IDP2VO6U7TPR27ALANCNFSM4HHVQVGA> .

elbaro · 2019-04-23T09:37:36Z

I think it is a problem in the plugin. Katex supports \gdef. You can try the code below in your browser. It works in my browser.

<!DOCTYPE html>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-dbVIfZGuN1Yq7/1Ocstc1lUEm+AT+/rCkibIcC/OmWo5f0EA48Vf8CytHzGrSwbQ" crossorigin="anonymous">
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" integrity="sha384-2BKqo+exmr9su6dir+qCw08N2ZKRucY4PrGQPPWU1A7FtlCGjmEGFqXCv5nyM5Ij" crossorigin="anonymous"></script>
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-kWPLUVMOks5AQFrykwIup5lo0m3iMkkHrD0uJ4H5cjeGihAutqP0yW0J6dpFiVkI" crossorigin="anonymous"
    onload="renderMathInElement(document.body);"></script>

<body>
    $$
    \gdef\plim{\operatorname{plim}}
    \plim asdf
    $$

    $$
    \plim asdf
    $$

</body>

This may be because the plugin does not call a rendering function with macros option, but I am not sure.

yzhang-gh · 2019-04-23T11:57:24Z

You are right. We haven't used the macro option.

https://katex.org/docs/supported.html#macros

PierreMarchand20 · 2019-05-06T15:25:35Z

It would be also nice to be able to store all the user-defined macros in an external file and load them in Katex. It is possible with the ‘macro’ option.

PierreMarchand20 · 2019-05-12T18:33:00Z

I am looking at how to add the macros option to katex, but it seems that the module used in this repo neilsustc/markdown-it-katex is not really maintained (waylonflinn/markdown-it-katex#23). So I suspect that the version of katex used is too old to do that.

Anyway, it may be worth it to change this dependency by another one (see previous link).

PierreMarchand20 · 2019-05-12T18:39:36Z

My bad, I can use the macros option anyway, but still, it may be a good idea to change this dependency.

yzhang-gh · 2019-05-12T19:03:49Z

The author said he would update it (last commented 2 days ago, in the issue you mentioned). (Actually, neilsustc/markdown-it-katex is my personal fork of that.)

yzhang-gh · 2019-05-12T19:54:08Z

Thanks to @PierreMarchand20, we now have this feature in the dev build (new option markdown.extension.katex.macros).

See macros part in the options page.

yzhang-gh · 2019-05-13T11:41:15Z

Seems we introduced a new problem

PierreMarchand20 · 2019-05-13T11:43:39Z

That is weird, we only added an option when calling markdown-it-katex. I will try with my version. FYI, there is also an option concerning the delimiters that we could add (not documented yet KaTeX/KaTeX#1944).

PierreMarchand20 · 2019-05-13T11:46:56Z

I cannot reproduce this issue :-/

upupming · 2019-05-13T13:42:52Z

Everything is well on my side, too (latest commit * d485552 🐜 #436 cont.):

upupming · 2019-05-13T13:52:58Z

@yzhang-gh According to the docs , you can see the error of KaTeX by setting the throwOnError to true at here:

vscode-markdown/src/extension.ts

Line 26 in d485552

throwOnError: false,

For example, this:

will throw an error in the debug console:

upupming · 2019-05-13T13:56:18Z

After that test, the error shows on my laptop, too 😭

I will try to fix it.

upupming · 2019-05-13T14:51:00Z

This is really strange, I have tested this code:

const katex = require('katex')

let html = katex.renderToString('1', {
  throwOnError: true,
  displayMode: false,
  macros:{},
});

console.log(html);

It works very well. And our code did the same thing but got an error:

Update: I got it, there must be something wrong with the VSCode extendMarkdownIt, when we print to html, everything works as expected, but VSCode rendering is not as expected.

upupming · 2019-05-13T16:36:39Z

Okay, I have fixed it, this is really a small problem. The get<object> actually does not return an Object, instead, it returns a string.

We should use getConfiguration instead!

PierreMarchand20 · 2019-05-13T16:43:02Z

That is weird no ? oO I used it this way because I thought that if we added other settings about katex, we needed to use the get function.

PierreMarchand20 · 2019-05-13T16:46:56Z

Looking at the definition:

/**
* Return a value from this configuration.
*
* @param section Configuration name, supports _dotted_ names.
* @return The value `section` denotes or `undefined`.
*/
get<T>(section: string): T | undefined;

it should return an object no ?

upupming · 2019-05-13T16:49:05Z

@PierreMarchand20 Yes, that is really interesting.
VSCode doesn't document too much about this. I have a test:

workspace.getConfiguration('markdown.extension.katex').get<object>('macros') as unknown as string == '{}'
// true

So, although the return type is an object, it is actually is a string.

PierreMarchand20 · 2019-05-13T16:49:44Z

Actually, I think the issue comes when the parameter markdown.extension.katex.macros has no value in the settings. At least, I have been able to reproduce the issue like this.

upupming · 2019-05-13T16:50:47Z

Yes, and now I have fixed it in the PR #443

PierreMarchand20 · 2019-05-13T16:51:55Z

But then, I think we can leave the get function no ? There must be a mistake in the default value or something.

upupming · 2019-05-13T16:52:26Z

I have been inspired by another VSCode plugin mdmath actually, it works very well:
https://github.com/goessner/mdmath/blob/e2f42ff70b1903e37c420b70896abde2f1ec7f57/extension.js#L32

upupming · 2019-05-13T16:54:56Z

But then, I think we can leave the get function no ? There must be a mistake in the default value or something.

You are right, I am going to fix the default value of markdown.extension.katex.macros in package.json.

PierreMarchand20 · 2019-05-13T16:56:50Z

But it seems that the default value I put is the same as in the package you mentioned

PierreMarchand20 · 2019-05-13T16:58:44Z

Ah no I see ^^here's why it was a string I guess

PierreMarchand20 · 2019-05-13T16:59:45Z

I have been inspired by another VSCode plugin mdmath actually, it works very well:
https://github.com/goessner/mdmath/blob/e2f42ff70b1903e37c420b70896abde2f1ec7f57/extension.js#L32

I actually looked at this repo when I did my pull request, but I did not understand why it needed all this to get the macros.

upupming · 2019-05-13T17:00:48Z

Haha, anyway we have fixed it, thanks for your help @PierreMarchand20 !

Have a nice day ❤️

PierreMarchand20 · 2019-05-13T17:04:04Z

Well thank you for fixing my mistake ! Second time I try to do something in typescript ^^

But you did fix a typo at first in your pull request that could be interesting to fix !!!

upupming · 2019-05-13T17:04:53Z

Yep, I have fixed it again~

yzhang-gh · 2019-05-13T18:04:22Z

Interesting

FYI, there is also an option concerning the delimiters that we could add (not documented yet KaTeX/KaTeX#1944).

Currently, the delimiters are handled by markdown-it-katex (called in the conversion from Markdown to HTML). The KaTeX auto-renderer is a post-HTML script, as I remember. There may be something we can borrow but only a few I guess.

"default": "{}" -> "default": {}

I actually have seen the same mistake recently (also from a PR, lol).

But you did fix a typo at first in your pull request that could be interesting to fix !!!

🤣

upupming · 2019-05-13T18:11:29Z

I am so sorry, just realized what mistake I made, thanks for pointing it out!

yzhang-gh · 2019-05-13T18:14:07Z

Nonono, I also didn't notice that. Thanks for all the contributions 👍

PierreMarchand20 · 2019-06-17T08:19:14Z

it does not work for me with the last update. I am trying to understand why, but in the meantime, here's my setting :

"markdown.extension.katex.macros": {
    "\\bfx" : "\\mathbf{x}",
    "\\bfy" : "\\mathbf{y}", 
    "\\bfn" : "\\mathbf{n}", 
    "\\bfu" : "\\mathbf{u}",
    "\\bfv" : "\\mathbf{v}",
    "\\bft" : "\\mathbf{t}",
    "\\bff" : "\\mathbf{f}",
    "\\bfe" : "\\mathbf{e}",

    "\\bfA" : "\\mathbf{A}", 
    "\\bfR" : "\\mathbf{R}", 
    "\\bfD" : "\\mathbf{D}", 
    "\\bfI" : "\\mathbf{I}", 
    "\\bfM" : "\\mathbf{M}", 
    "\\bfV" : "\\mathbf{V}", 
    "\\bfW" : "\\mathbf{W}", 
    "\\bfC" : "\\mathbf{C}", 
    "\\bfP" : "\\mathbf{P}",  
    "\\bfZ" : "\\mathbf{Z}", 

    "\\bbN" : "\\mathbb{N}",
    "\\bbR" : "\\mathbb{R}",
    "\\bbC" : "\\mathbb{C}",
    "\\wH"  : "\\widetilde{H}",


    "\\calD" : "\\mathcal{D}",
    "\\calT" : "\\mathcal{T}",
    "\\calR" : "\\mathcal{R}",
    "\\calP" : "\\mathcal{P}",
    "\\calV" : "\\mathcal{V}",
    "\\calW" : "\\mathcal{W}",
    "\\calJ" : "\\mathcal{J}",
    "\\calE" : "\\mathcal{E}",

    "\\diff" : "\\mathop{}\\!\\mathrm{d}",
    "\\supp"  : "\\operatorname{supp}",
    "\\grad"  : "\\operatorname{grad}",   
    "\\Span"  : "\\operatorname{span}",   
    "\\range" : "\\operatorname{range}", 
    "\\diag"  : "\\operatorname{diag}", 
    "\\cond"  : "\\operatorname{cond}", 
    "\\dist"  : "\\operatorname{dist}"
  },

PierreMarchand20 · 2019-06-17T08:34:58Z

fixed in #473, the option for giving macros to katex is macros and not userMacros

Hadron67 · 2019-06-18T13:25:18Z

I'm still having this issue in v2.4.0. It seems that #473 isn't included in the release, i've checked ~/.vscode/extensions/yzhang.markdown-all-in-one-2.4.0/dist/extension.js, the macro option name is still userMacros. Reinstalling doesn't work.

In addition, the check Object.keys(userMacros).length !== 0 is possibly unnecessary, since the macro option should always be presented for \gdef to work.

yzhang-gh · 2019-06-18T21:09:56Z

The fix has not been shipped yet. You can try out our dev build.

As for the check Object.keys(userMacros).length !== 0, it is for the non-macros users. For that case, there will be some unexpected results even if we pass in an empty {}.

yzhang-gh added the Issue: Feature Something brand new. label Apr 23, 2019

yzhang-gh changed the title ~~Support \gdef in katex~~ Support \gdef (macros) in KaTeX Apr 23, 2019

PierreMarchand20 mentioned this issue May 12, 2019

Add KaTeX macros support #441

Merged

yzhang-gh added a commit that referenced this issue May 12, 2019

🐜 #426

ae2fa1d

yzhang-gh mentioned this issue May 13, 2019

图片 base64 编码问题：中文路径，网络图片 #436

Open

3 tasks

upupming added a commit to upupming/vscode-markdown that referenced this issue May 13, 2019

Fixed yzhang-gh#426 getConfiguration

0ce61eb

upupming mentioned this issue May 13, 2019

Fix macros from string to object #443

Merged

linsui mentioned this issue May 16, 2019

aligned 环境中无法换行 #445

Closed

yzhang-gh closed this as completed in 319f390 Jun 16, 2019

bluethon mentioned this issue Dec 17, 2019

User-defined macros can't print to html correctly #579

Closed

Lemmingh added Area: Math Res: Fixed Fix is checked in, but it might be a few weeks until a release. labels Jun 30, 2021

Support \gdef (macros) in KaTeX #426

Support \gdef (macros) in KaTeX #426

Comments

elbaro commented Apr 23, 2019 • edited Loading

What is the problem?

How can I reproduce it?

upupming commented Apr 23, 2019 via email

elbaro commented Apr 23, 2019

yzhang-gh commented Apr 23, 2019

PierreMarchand20 commented May 6, 2019

PierreMarchand20 commented May 12, 2019

PierreMarchand20 commented May 12, 2019

yzhang-gh commented May 12, 2019

yzhang-gh commented May 12, 2019

yzhang-gh commented May 13, 2019

PierreMarchand20 commented May 13, 2019 • edited Loading

PierreMarchand20 commented May 13, 2019

upupming commented May 13, 2019

upupming commented May 13, 2019

upupming commented May 13, 2019

upupming commented May 13, 2019 • edited Loading

upupming commented May 13, 2019 • edited Loading

PierreMarchand20 commented May 13, 2019 • edited Loading

PierreMarchand20 commented May 13, 2019

upupming commented May 13, 2019 • edited Loading

PierreMarchand20 commented May 13, 2019 • edited Loading

upupming commented May 13, 2019

PierreMarchand20 commented May 13, 2019 • edited Loading

upupming commented May 13, 2019

upupming commented May 13, 2019

PierreMarchand20 commented May 13, 2019

PierreMarchand20 commented May 13, 2019

PierreMarchand20 commented May 13, 2019

upupming commented May 13, 2019 • edited Loading

PierreMarchand20 commented May 13, 2019

upupming commented May 13, 2019

yzhang-gh commented May 13, 2019

upupming commented May 13, 2019

yzhang-gh commented May 13, 2019

PierreMarchand20 commented Jun 17, 2019

PierreMarchand20 commented Jun 17, 2019

Hadron67 commented Jun 18, 2019

yzhang-gh commented Jun 18, 2019

elbaro commented Apr 23, 2019 •

edited

Loading

PierreMarchand20 commented May 13, 2019 •

edited

Loading

upupming commented May 13, 2019 •

edited

Loading

upupming commented May 13, 2019 •

edited

Loading

PierreMarchand20 commented May 13, 2019 •

edited

Loading

upupming commented May 13, 2019 •

edited

Loading

PierreMarchand20 commented May 13, 2019 •

edited

Loading

PierreMarchand20 commented May 13, 2019 •

edited

Loading

upupming commented May 13, 2019 •

edited

Loading