fix(ci/markdownlint): add a search-replace rule to put some html tags in code spans #36110
Conversation
OnkarRuikar
requested review from
wbamberg and
chrisdavidmills
and removed request for
a team
github-actions
bot
added
Content:HTML
There was a problem hiding this comment.
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.
|
This was brought up/requested by Claas on Discord. We'll have to wait for his views. |
Josh-Cena
requested review from
caugner
and removed request for
mdn-bot,
a team and
wbamberg
.../en-us/mdn/writing_guidelines/page_structures/page_types/html_element_page_template/index.md
Outdated
Show resolved
Hide resolved
| @@ -367,7 +367,7 @@ The following example shows simple usage of the `<audio>` element to play an OGG | |||
|
|
|||
| For details on when autoplay works, how to get permission to use autoplay, and how and when it's appropriate to use autoplay, see our [autoplay guide](/en-US/docs/Web/Media/Autoplay_guide). | |||
|
|
|||
| ### \<audio> element with \<source> element | |||
| ### `<audio>` element with \<source> element | |||
There was a problem hiding this comment.
I have yet to learn about the broader purpose of this. But looks like we'll have to handle a lot of escaped tags. Let me know how to proceed.
\<a>
\<absoluteIRI>
\<all_urls>
\<angle>
\<anything>
\<App>
\<aside>
\<b>
\<base>
\<body>
\<BOM>
\<bookinstance_id>
\<br>
\<caption>
\<client>
\<code>
\<col>
\<color>
\<Color>
\<comment>
\<coordinate>
\<CR>
\<credentials>
\<dasharray>
\<day>
\<em>
\<email>
\<embed>
\<endpoint>
\<etag>
\<etag_value>
\<FF>
\<fieldset>
\<form>
\<frequency>
\<funciri>
\<FuncIRI>
\<g>
\<h1>
\<h2>
\<head>
\<host>
\<hour>
\<hr>
\<i>
\<icccolor>
\<id>
\<iframe>
\<img>
\<integer>
\<IRI>
\<key>
\<label>
\<legend>
\<length>
\<LF>
\<link>
\<locale>
\<LS>
\<math>
\<menu>
\<menulist>
\<menupopup>
\<method>
\<mfrac>
\<mi>
\<minute>
\<mo>
\<month>
\<mroot>
\<mrow>
\<msqrt>
\<myusername>
\<name>
\<NBSP>
\<none>
\<number>
\<Number>
\<object>
\<opacity>
\<origin>
\<paint>
\<parsererror>
\<path>
\<path_data>
\<percentage>
\<policyName>
\<port>
\<position>
\<pre>
\<product>
\<protocol>
\<proxy1>
\<proxy2>
\<PS>
\<pseudonym>
\<realm>
\<region>
\<relativeIRI>
\<response>
\<script>
\<second>
\<size>
\<something>
\<source>
\<SP>
\<string>
\<strong>
\<style>
\<svg>
\<switch>
\<TAB>
\<tbody>
\<template>
\<template_extension>
\<tfoot>
\<th>
\<thead>
\<time>
\<Todo>
\<track>
\<treecol>
\<type>
\<u>
\<unit>
\<uri>
\<url>
\<URL>
\<USP>
\<value>
\<version>
\<VT>
\<year>
\<ZWJ>
\<ZWNBSP>
\<ZWNJ>
There was a problem hiding this comment.
Strong -1 on escaping all them. "<ZWJ>" etc. are Unicode transcriptions and should not be code-formatted. IMO CSS types should not either but we already do, so let's do that consistently. Any code entity such as HTML/XML/JSX tags should indeed be code formatted.
At the end of the day I consider this to have a net 0 benefit though. We are just changing our content to please some engineering limitation.
There was a problem hiding this comment.
We need to discuss this in the content call.
We are just changing our content to please some engineering limitation.
I see. Input sanitization is much better than restraining the content.
…html_element_page_template/index.md
|
How about we convert to |
|
This pull request has merge conflicts that must be resolved before it can be merged. |
|
@OnkarRuikar Thank you for opening this PR, and sorry for not getting back to you earlier. I allowed myself to cherry-pick (and extend) your change here: mdn/translated-content-de@fb7a454 |
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:mdcommand to fix the content files.cc @caugner