nodejs / nodejs/nodejs.org

MDX causing inline JS

Open
#8,160 0 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

Ref: https://github.com/nodejs/nodejs.org/pull/8132#issuecomment-3268255553

Currently, any JS needed to handle our markdown components is all inline on the website (i.e. <script> tags). It would make for smaller web pages if this could be offloaded to imported scripts.

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 with the discussion in the linked pull request, then inspect how MDX markdown components add inline JavaScript to the website. The work is done when that component behavior is supplied by imported scripts instead, with smaller generated web pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, typescript
Domain
frontend, performance, web-dev
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.