styleguidist/react-styleguidist

Use backslash to escape multiple markdown sign will display incorrect.

Open

#1.709 geöffnet am 4. Nov. 2020

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
bughelp wanted

Repository-Metriken

Stars
 (11.091 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Current behavior

At JSCode at jsx file or md file, it will display incorrect if use multiple backslash to escape multiple underscore at a variable.

To reproduce

At Jsx file:


/**  
 * a\_b\_c\_d  
 */  
const MyComponent = () => {};
export MyComponent;

At md file

a\_b\_c\_d

Both result at react-styleguidist:

<p class="rsg--para-40">a<em class="rsg--text-52 rsg--inheritSize-53 rsg--baseColor-57 rsg--em-59">b</em>c_d</p>

Expected behavior

<p class="rsg--para-40">a_b_c_d</p>

Contributor Guide

Research-Richtung
Untersuchen Sie, wie react styleguidist Escape Sequenzen in Markdown verarbeitet. Überprüfen Sie die verwendete Markdown Bibliothek (wahrscheinlich marked oder rehype) und ob die Backslash Escape korrekt verarbeitet wird, insbesondere in Codeblöcken oder JSX Kommentaren.
Tech Stack
typescriptjavascriptreact
Domain
frontenddocumentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
MarkdownReact
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70