Documentation SK README: Malformed HTML
jpl-jengelke opened this issue · comments
Checked for duplicates
Yes - I've already checked
Website or Best Practice Guide?
Best Practice Guide
Describe the bug
When I edited the documentation starter kit README.md file, I was alerted that some html tags were deprecated or unsupported.
What did you expect?
I expected no errors when editing the markdown using an IDE.
However, the IDE reported the following concerns:
- Line 4:
<div align="center">
-- Obsolete attribute (deprecated) - Line 10:
<h1 align="center">
-- Obsolete attribute (deprecated) - Line 15:
<pre align="center">
-- Attributealign
is not allowed here.
Reproducible steps
1. Open the `README-sw-proj-template.md` file in a static HTML5 language checker, like that built-in to the `PyCharm` IDE.
PyCharm inspects HTML files to conform to the final W3C HTML5 specification.
Environment
- PyCharm 2022.2.3 / htmlparser2
Interesting @jpl-jengelke - let me think about this. We could potentially upgrade the tags or go with a more pure Markdown approach to eliminate tags altogether.