tc39 / tc39/ecmarkup

Auto-escape JSX under code listing?

Open
#409 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
245
Forks
80
Avg merge
10h 46m
Merged PRs (30d)
2

Description

Have we consider automatically escaping JSX under <pre><code>...</code></pre> or providing an emu-code with a similar functionality?

It will benefit proposals writing sample code with JSX such as do-expressions, pattern matching. I'm even thinking of using ecmarkup for the facebook/jsx github page itself.

Currently, one would have to manually convert them to HTML entities, which are not very convenient to read or edit it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the handling for

 blocks and checking whether an emu-code element already has an entry point. Compare the two proposed interfaces and determine how JSX examples should be represented without manual HTML entities. Done means a selected approach is implemented and demonstrated for JSX code in ecmarkup output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
content, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.