Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(ci/markdownlint): add a search-replace rule to put some html tags in code spans #36110

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(ci/markdownlint): add a search-replace rule to put some html tags in code spans #36110

wants to merge 1 commit into from
+28 −21

Conversation

OnkarRuikar
Copy link
Contributor

We are currently using backslash (\<audio>) to allow HTML tags in markdown text. It would be better to use markdown code spans(`<audio>`) instead.

I added the search-replace rule and ran yarn fix:md command to fix the content files.

cc @caugner

@OnkarRuikar OnkarRuikar requested review from mdn-bot and a team as code owners September 30, 2024 06:30
@OnkarRuikar OnkarRuikar requested review from wbamberg and chrisdavidmills and removed request for a team September 30, 2024 06:30
@github-actions github-actions bot added Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs Content:Learn Learning area docs Content:Media Media docs Content:Performance Web performance docs Content:Learn:JavaScript Learning area JavaScript docs Content:Meta Content in the meta docs Content:Learn:HTML Learning area HTML docs Content:Learn:Forms Learning area Forms docs Content:Learn:Cross-Browser-Testing Learning area Cross-Browser-Testing docs system [PR only] Infrastructure and configuration for the project size/s [PR only] 6-50 LoC changed labels Sep 30, 2024
@github-actions GitHub Actions
Copy link
Contributor

Preview URLs (16 pages)
Flaws (10)

Note! 14 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Learn/Learning_and_getting_help
Title: Learning and getting help
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/play

URL: /en-US/docs/Web/API/HTMLMediaElement
Title: HTMLMediaElement
Flaw count: 9

  • macros:
    • /en-US/docs/Web/API/HTMLMediaElement/played does not exist
    • /en-US/docs/Web/API/HTMLMediaElement/seeking does not exist
    • /en-US/docs/Web/API/MediaController does not exist
    • /en-US/docs/Web/API/MediaController does not exist
    • /en-US/docs/Web/API/HTMLMediaElement/mozAudioCaptured does not exist
    • and 4 more flaws omitted
External URLs (1)

URL: /en-US/docs/Learn/Tools_and_testing/Cross_browser_testing/Feature_detection
Title: Implementing feature detection

chrisdavidmills
chrisdavidmills reviewed Sep 30, 2024
View reviewed changes
Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

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

This seems reasonable to me, @OnkarRuikar, it is usually what I do in titles, etc.

But I don't know much about markdown lint, so I'll defer approving to someone else.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisdavidmills chrisdavidmills chrisdavidmills left review comments

@mdn-bot mdn-bot Awaiting requested review from mdn-bot mdn-bot is a code owner

@wbamberg wbamberg Awaiting requested review from wbamberg wbamberg is a code owner automatically assigned from mdn/yari-content-web-api

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Content:HTML Hypertext Markup Language docs Content:Learn:Cross-Browser-Testing Learning area Cross-Browser-Testing docs Content:Learn:Forms Learning area Forms docs Content:Learn:HTML Learning area HTML docs Content:Learn:JavaScript Learning area JavaScript docs Content:Learn Learning area docs Content:Media Media docs Content:Meta Content in the meta docs Content:Performance Web performance docs Content:WebAPI Web API docs size/s [PR only] 6-50 LoC changed system [PR only] Infrastructure and configuration for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@OnkarRuikar @chrisdavidmills