-
Notifications
You must be signed in to change notification settings - Fork 19
Fix markdown formatting in existing documentation #13
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
Fix markdown formatting in existing documentation #13
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding <br>
to the list of accepted tags in markdownlint.yaml
such as:
MD033: # Disallow inline HTML, with some exceptions
allowed_elements:
- details
- summary
- br
will allow the table that uses newlines to be properly rendered and eliminate the lint warning. Then, the \n
in Asset\GUI\WND_Controls\user.md
used in the tags table could be reverted back to <br>
and be rendered properly.
90a54bd
to
d7002f9
Compare
Added |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Look good
This PR fixes the markdown formatting in the existing documentation to comply with the new linting standards.