nodejs / nodejs/nodejs.org

bug(`rehype-shiki`): sequential codeboxes are merged together

Open
#7,803 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
6.9k
Forks
6.5k
Avg merge
2d 8h
Merged PRs (30d)
29

Description

Current behavior:

For now, our codebox system merges all MD snippets together.

Expected behavior:

We need to have a check that splits into several codeboxes if there are several cjs/esm in a row.

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 rehype-shiki codebox processing and reproduce the behavior with several consecutive cjs/esm snippets. Trace where adjacent Markdown snippets are merged; done means sequential cjs/esm blocks render as separate codeboxes, matching the expected behavior shown in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.