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.

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

[Markdown] [Web/HTML] Convert HTML docs to Markdown - DO NOT SQUASH MERGE #9303

Merged
merged 7 commits into from
Sep 29, 2021

Conversation

wbamberg
Copy link
Collaborator

See #8961 for the "preparation" work.

This PR converts Web/HTML to Markdown.

Conversion report summary:

## All unhandled elements

- table.properties (140)
- kbd (96)
- tr (73)
- table.no-markdown (30)
- td (29)
- th (22)
- table.standard-table (19)
- td[colSpan="2"] (17)
- th[scope="row"] (13)
- sub (5)
- td[rowSpan="3"] (5)
- td[rowSpan="4"] (5)
- table.fullwidth.standard-table (3)
- sup (3)
- th[colSpan="2"][scope="col"] (2)
- table (2)
- td[rowSpan="2"] (2)
- th[scope="col"] (2)
- table.fullwidth-table (1)
- td[colSpan="3"] (1)
- th[colSpan="2"] (1)
- th[rowSpan="2"][scope="col"] (1)
- td[rowSpan="6"] (1)
- td[rowSpan="14"] (1)
- td[rowSpan="7"] (1)
- td[rowSpan="9"] (1)

Full conversion report: https://gist.github.com/wbamberg/af1992d83e5fa9bb4fc255c7417bfdde

The only unconverted elements are <sub>, <sup>, <kbd> and tables.

<sub> and <sup>

These elements only appear in the actual pages that document them, to demonstrate proper usages:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/sub#usage_notes
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/sup#usage_notes

It seems much better to keep the HTML here.

<kbd>

As we have for other doc sets, this PR keeps <kbd> as HTML.

<table>

Many tables here are unconverted:

@wbamberg wbamberg requested a review from a team as a code owner September 27, 2021 20:55
@wbamberg wbamberg requested review from estelle and removed request for a team September 27, 2021 20:55
@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label Sep 27, 2021
@wbamberg
Copy link
Collaborator Author

To coordinate reviews I've created https://docs.google.com/spreadsheets/d/1QnKzVj8Q4OIw7_FFjCTyx3U5wWO9cIUUgVozKDtcm2o/edit#gid=0

As before, the purpose of this is just to ensure different people review different pages.

@github-actions

This comment has been minimized.

@wbamberg wbamberg changed the title [Markdown] [Web/HTML] Convert HTML docs to Markdown [Markdown] [Web/HTML] Convert HTML docs to Markdown - DO NOT SQUASH MERGE Sep 27, 2021
@estelle estelle mentioned this pull request Sep 29, 2021
Copy link
Contributor

@teoli2003 teoli2003 left a comment

Choose a reason for hiding this comment

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

Found 2 sectioning flaws introduced by md, fixed them (and checked with the flaw dashboard that I didn't miss any), and two other nits.

I think we are good to go.

@wbamberg wbamberg merged commit 7b8e35d into mdn:main Sep 29, 2021
@wbamberg
Copy link
Collaborator Author

Thanks for all your work on this @teoli2003 !

@teoli2003
Copy link
Contributor

💯 👏

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:HTML Hypertext Markup Language docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants