content-metadata.md: unwrap HTMLBlock; markdown prose + indented HTML tables#47
Merged
Merged
Conversation
… tables
The whole body of this page was wrapped in a JSX
<HTMLBlock>{`...`}</HTMLBlock> template literal, which kept ReadMe's
markdown processor from rendering the 15 [text](doc:slug) references
inside (ContentType -> roInt, Rating Attribute Icons, ifHttpAgent,
Roku OS 9.3 release notes, content-protection, etc.).
Drop the wrapper and rebuild the page so:
- Prose (paragraphs, lists, headings, blockquotes) is plain markdown.
- HTML tables stay HTML (they have nested tables, <br />, <a>, and
bullet lists inside cells), but are now indented by nesting depth.
Cells that contain a nested matrix table are broken across lines so
the inner <table> sits at a reasonable level.
- Standalone <pre><code>...</code></pre> snippets become markdown
fenced blocks (and the HTML entities </> inside them are
decoded so they render as `<contentType>` etc.).
- The Confluence-era hljs syntax-highlighting <span> wrappers are
stripped (they were rendering literally outside HTMLBlock).
- { and } in <td> text are written as JSX template literals
({'{'} / {'}'}) so MDX doesn't read them as JSX expressions.
- ".parameters[0].body" has its [0] escaped so MDX doesn't read it
as a reference-style link.
- <img> tags are self-closed for MDX.
- Link styles are unified to markdown: <a href="/dev/docs/SLUG"> and
[text](/dev/docs/SLUG) become [text](doc:SLUG); same-page
<a href="#anchor"> becomes [text](#anchor); external <a href="URL">
with matching text becomes [URL](URL).
Inbound links to #digital-rights-management-drm-control-attributes
and #playback-configuration-attributes are preserved because the
heading text didn't change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The whole body of
content-metadata.mdwas wrapped in a JSX<HTMLBlock>{...}</HTMLBlock>template literal. ReadMe doesn't run its markdown processor insideHTMLBlock, so the 15[text](doc:slug)references inside (ContentType →roInt, Rating Attribute Icons,ifHttpAgent, Roku OS 9.3 release notes,content-protection, etc.) rendered literally as bracket-and-parens text.Changes
Drop the wrapper and rebuild the page so:
<br />,<a>, and bullet lists inside cells — but are now indented by nesting depth. Cells that contain a nested matrix table are broken across lines so the inner<table>sits at a reasonable level.<pre><code>...</code></pre>snippets become markdown fenced blocks (and the</>entities inside them are decoded so they render as<contentType>etc.).hljssyntax-highlighting<span>wrappers are stripped (they would have rendered literally outsideHTMLBlock).{and}in<td>text are written as JSX template literals ({'{'}/{'}'}) so MDX doesn't read them as JSX expressions;".parameters[0].body"has its[0]escaped so it isn't read as a reference-style link;<img>tags are self-closed.<a href="/dev/docs/SLUG">and[text](/dev/docs/SLUG)become[text](doc:SLUG); same-page<a href="#anchor">becomes[text](#anchor); external<a href="URL">with matching text becomes[URL](URL).Inbound links to
#digital-rights-management-drm-control-attributesand#playback-configuration-attributesare preserved because the heading text didn't change.