styleguidist/react-styleguidist

Use backslash to escape multiple markdown sign will display incorrect.

Open

#1,709 opened on Nov 4, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Investigate how react styleguidist processes escape sequences in markdown. Check the markdown library used (likely marked or rehype) and see if backslash escaping is handled correctly, especially in code blocks or JSX comments.
Tech stack
typescriptjavascriptreact
Domain
frontenddocumentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
MarkdownReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70