facebook/lexical

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

Open

Aperta il 10 dic 2024

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)JavaScript (16.523 star) (1349 fork)batch import
good first issuemarkdown

Descrizione

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.

Guida contributor

Tech stack
javascripttypescript
Dominio
frontend
Tipo issue
bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
JavaScript/TypeScriptLexical Markdown transformersRegex basicsGit and GitHub workflow
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75
Direzione di ricerca
Esamina il file indice di MarkdownTransformers (packages/lexical playground/src/plugins/MarkdownTransformers/index.ts) per comprendere la struttura dei trasformatori esistenti. Osserva il trasformatore INLINE EQUATION e crea un nuovo trasformatore BLOCK EQUATION che corrisponda al pattern '$$...$$'. Assicurati che il nuovo trasformatore sia esportato correttamente e registrato nel MarkdownShortcutPlugin. Testa la correzione seguendo i passaggi di riproduzione nella sandbox di Lexical.