markbind icon indicating copy to clipboard operation
markbind copied to clipboard

Import `beg_end` markdown-it-texmath delimiters by default

Open yyccbb opened this issue 8 months ago • 4 comments

Please confirm that you have searched existing issues in the repo

Yes, I have searched the existing issues

Any related issues?

No response

What is the area that this feature belongs to?

Author Usability

Is your feature request related to a problem? Please describe.

\begin{} \end{} Tex environment is commonly used if the user wants to create block equations, aligned environment, etc. They do not seem to have other usage in MarkBind other than indicating a Tex environment. Currently, users have to add the following lines to site.json to activate the environment, which I think is slightly troublesome and unnecessary.

{
  "plugins": [
    "mathDelimiters"
  ],
  "pluginsContext" : {
    "mathDelimiters" : {
      "delimiters": ["beg_end"]
    }
  },
}

Describe the solution you'd like

We should require the beg_end delimiter by default.

Describe alternatives you've considered

No response

Additional context

No response

yyccbb avatar Apr 20 '25 10:04 yyccbb

Hi I am working on the project for CP3108B. I would like to work on this issue. May I know whether I can proceed?

Golddirio avatar Jul 11 '25 07:07 Golddirio

@Golddirio Go ahead.

damithc avatar Jul 11 '25 10:07 damithc

Thank you prof

Golddirio avatar Jul 11 '25 12:07 Golddirio

Just to confirm my understanding of this feature request — is the goal:

  1. To make beg_end the default delimiter only within the Math Delimiters plugin, or
  2. To make beg_end a default delimiter in MarkBind’s core math processing logic?

I don't think it is (1). The Math Delimiters plugin exists mainly for users to add custom delimiters beyond the defaults (dollars and brackets), so adding a default option into a plugin to let u choose additional custom delimiters doesn’t align well with its purpose.

If it’s (2), then that makes sense — it would mean beg_end is available out of the box without requiring the plugin or site.json changes, which aligns better with user expectations for common TeX environments.

I will assume that the end state that is issue is suggesting is towards (2).

References:

gerteck avatar Aug 05 '25 03:08 gerteck