search

NASA-AMMOS / slim

Software Lifecycle Improvement & Modernization
https://nasa-ammos.github.io/slim/
Apache License 2.0
24 stars 9 forks source link

Documentation SK README: Malformed HTML #81

Open jpl-jengelke opened 1 year ago

jpl-jengelke commented 1 year ago

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. malformed_tags

What did you expect?

I expected no errors when editing the markdown using an IDE.

However, the IDE reported the following concerns:

  1. Line 4: <div align="center"> -- Obsolete attribute (deprecated)
  2. Line 10: <h1 align="center"> -- Obsolete attribute (deprecated)
  3. Line 15: <pre align="center"> -- Attribute align 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
riverma commented 1 year ago

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.