facebook/lexical

Bug: Block math equation is falsely converted to inline equation on MarkdownShortcutPlugin

Fermée

#6 936 ouverte le 10 déc. 2024

 (6 commentaires) (0 réaction) (0 personne assignée)JavaScript (1 349 forks)batch import
good first issuemarkdown

Métriques du dépôt

Stars
 (16 523 étoiles)
Métriques de merge PR
 (Merge moyen 2j 16h) (103 PRs mergées en 30 j)

Description

Typing an equation like "$$x^2 + y^2 = z^2$$" via "Insert Equation" and then pressing the MarkdownShortcutPlugin changes the equation to inline ($...$).

Lexical version: Current Playground version

Steps To Reproduce

  1. Enter an equation, e.g. "x^2 + y^2 = z^2" via the toolbar (Insert -> Insert Equation) and uncheck "inline".
  2. Press the Markdown button

Link to code example: https://playground.lexical.dev/

The current behavior

Block math equations like "$$...$$" are converted to inline "$...$" when using the ##MarkdownShortcutPlugin.

The expected behavior

Block math equations like "$$...$$" should stay the same when using the MarkdownShortcutPlugin.

Potential Solutions

Possibly quick: A new BLOCK_EQUATION transformer could be added to address the "$$" scenario. MarkdownTransformers Way more complicated: One might migrate "$, $$" in general to modern LaTex syntax like "[...]"

Impact of fix

Users who rely on markdown capabilities are type safe with equations.

Guide contributeur