Skip to content

Conversation

tintinhamans
Copy link
Contributor

This PR fixes the markdown formatting in the existing documentation to comply with the new linting standards.

@tintinhamans tintinhamans mentioned this pull request Mar 8, 2025
Copy link

@vitimiti vitimiti left a 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.

@tintinhamans tintinhamans force-pushed the arctic/fix-markdown-formatting branch from 90a54bd to d7002f9 Compare March 8, 2025 15:24
@tintinhamans
Copy link
Contributor Author

Added br to allowed HTML tags, reverted table change.

Copy link

@vitimiti vitimiti left a 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

@tintinhamans tintinhamans requested review from DevGeniusCode and removed request for sorcerer86pt March 8, 2025 15:31
Copy link
Contributor

@DevGeniusCode DevGeniusCode left a comment

Choose a reason for hiding this comment

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

Look good

@tintinhamans tintinhamans merged commit dee16b8 into TheSuperHackers:main Mar 8, 2025
1 check passed
@tintinhamans tintinhamans deleted the arctic/fix-markdown-formatting branch March 8, 2025 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants