Skip to content

Conversation

@kashish2710
Copy link
Contributor

@kashish2710 kashish2710 commented Dec 20, 2025

Removes the invalid type attribute from the <video> element in the
Creepy-crawly splash page solution and updates the instructions to avoid
misleading learners. The type attribute should only be used with
<source> elements, not directly on <video>.

@kashish2710 kashish2710 requested a review from a team as a code owner December 20, 2025 06:31
@kashish2710 kashish2710 requested review from hamishwillee and removed request for a team December 20, 2025 06:31
@github-actions github-actions bot added Content:Learn Learning area docs size/xs [PR only] 0-5 LoC changed labels Dec 20, 2025
Just below the `<h1>`, add a `<video>` element that embeds our header video into the page. We'd like it to do the following:

- Specify the [media type](/en-US/docs/Web/HTTP/Guides/MIME_types) of the video.
- If you provide multiple video sources, specify the media type using <source> elements.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
error MD033/no-inline-html Inline HTML [Element: source]

@kashish2710
Copy link
Contributor Author

I noticed the MD033/no-inline-html warning from reviewdog regarding the use of in Markdown. To follow the linting rules and avoid inline HTML, I removed the bullet about specifying elements and the media type.
The rest of the instructions remain the same. This ensures the Markdown stays valid while keeping the guidance clear for learners.

@wbamberg
Copy link
Collaborator

I noticed the MD033/no-inline-html warning from reviewdog regarding the use of in Markdown. To follow the linting rules and avoid inline HTML, I removed the bullet about specifying elements and the media type.

The reason for this is that you referred to "<video>" unescaped in Markdown, and because you can embed HTML in Markdown, that gets interpreted as HTML. Options for fixing it, from worse to better:

  • escape the opening "<", like "\<video"
  • put it in code formatting, like "`<video>`"
  • use the htmlelement macro, like '{{htmlelement("video")}}'

However, I think in this case it is better to omit the bullet entirely, as you have done, because there's no expectation that the reader will use multiple files (only one is provided).

@tristantheb , thank you for filing this issue. Does the fix look good to you?

Just below the `<h1>`, add a `<video>` element that embeds our header video into the page. We'd like it to do the following:

- Specify the [media type](/en-US/docs/Web/HTTP/Guides/MIME_types) of the video.
- If you provide multiple video sources, specify the media type using <source> elements.
Copy link
Member

@tristantheb tristantheb Dec 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-- If you provide multiple video sources, specify the media type using <source> elements.
+- If you provide multiple video sources, specify the media type using {{HTMLElement("source")}} elements.

When you want to add an html element, it's with this macro or with backticks like this

-- If you provide multiple video sources, specify the media type using <source> elements.
+- If you provide multiple video sources, specify the media type using `<source>` elements.

;)

@tristantheb
Copy link
Member

tristantheb commented Dec 20, 2025

@tristantheb , thank you for filing this issue. Does the fix look good to you?

Looks good for me, when it's sent, I'll let the person who reported the issue on Discord know that it's being fixed :D

Thanks 🙏🏻

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thank you @kashish2710 and @tristantheb !

@wbamberg wbamberg merged commit d133373 into mdn:main Dec 20, 2025
7 checks passed
wbamberg added a commit to wbamberg/content that referenced this pull request Dec 24, 2025
…skeys-guide

* origin/add-passkeys-guide:
  Clarify fetch() error handling behavior for Response (mdn#42497)
  Add code example to Closure glossary entry (mdn#42477)
  42252 add new relative units ff release (mdn#42470)
  Remove duplicated word (mdn#42496)
  42252 add new relative units (mdn#42469)
  TrustedTypes: Range.createContextualFragment() (mdn#42493)
  Fix CSS, HTML, and HTTP landing pages to match sidebar content and order (mdn#42460)
  TT: CSP trusted types/require-trusted... fixes (mdn#42461)
  Improve console output formatting in Recursion glossary (mdn#42478)
  Add Sec-CH-Width + consistency fixes (mdn#42453)
  webextensions/manifest.json/options_page: typo (mdn#42394)
  webextensions/api/tabs/onupdated: Fix section link (mdn#42393)
  fix: add missing closing parenthesis (mdn#42482)
  docs: mark srcData as required in bufferSubData (mdn#42483)
  docs(learn): remove invalid type attribute from video example (mdn#42479)
  Drop 'read-only' from role (mdn#42474)
  Fix: Update bufferSubData parameters to match WebGL 1 spec mdn#42315 (mdn#42411)
  chore: Replace links with `cssxref` macro in the learn area (mdn#42446)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:Learn Learning area docs size/xs [PR only] 0-5 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants