mdn / mdn/data

Full mdn data for browser / javascript apis + html (tags, attributes, events, props)

Open
#415 0 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

idle
Dominant language
JavaScript
Stars
787
Forks
216
Avg merge
1d 5h
Merged PRs (30d)
6

Description

Seeing autogenerated types in css-type is really nice. When using React or Preact, their type definitions only have names of elements but not any documentation about their usage.

Would be really useful to have list of html/svg tags, their possible attributes, events, props documented in mdn/data/html/*.json files, this would make it very easy to generate auto-generated types for JSX, that are 1:1 with mdn which tries to stay up-to-date with spec.

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 reviewing the existing mdn/data/html/*.json files and the linked css-type example to understand the current data shape. The issue is done when the requested HTML/SVG tags, attributes, events, and props are represented comprehensively enough to support generated JSX types, but the scope and schema still need definition.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, javascript
Domain
documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.