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

Ignore images in code snippets #30

Closed
kendallgassner opened this issue Jul 18, 2023 · 3 comments · Fixed by #33
Closed

Ignore images in code snippets #30

kendallgassner opened this issue Jul 18, 2023 · 3 comments · Fixed by #33
Assignees
Labels
bug Something isn't working

Comments

@kendallgassner
Copy link
Collaborator

If a user adds an image in a code snippet, we should ignore the alt text.

<img alt='' src='' /> 
@github-actions
Copy link

Uh oh! @kendallgassner, the image you shared is missing helpful alt text. Check your issue body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

@kendallgassner kendallgassner changed the title Ignore Code Snippets Ignore images in code snippets Jul 18, 2023
@github-actions
Copy link

Uh oh! @kendallgassner, the image you shared is missing helpful alt text. Check your issue body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

@khiga8
Copy link
Contributor

khiga8 commented Jul 18, 2023

This ties to #28, which I believe is raising a false positive due to the code snippet in the release notes.

I think the long term solution is going to be to use a markdown parser like markdownlint to parse the markdown body and raise errors, rather than regex matching the string with bash like we currently do. This would be a pretty big overhaul of the code, but we do have existing markdownlint rules we could use in markdownlint-github.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
3 participants