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.

Sign up for GitHub

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

Jump to bottom

🐛 Bug: README.md badge links have visual underlines #1027

Closed
3 tasks done
JoshuaKGoldberg opened this issue Nov 14, 2023 · 4 comments · Fixed by #1030
Closed
3 tasks done

🐛 Bug: README.md badge links have visual underlines #1027

JoshuaKGoldberg opened this issue Nov 14, 2023 · 4 comments · Fixed by #1030
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Expected

I like a clean README.md. No weird little visual inconsistencies around link underlines or whatnot.

Actual

There are little link underlines outside the badge images in generated README.mds 😬

Screenshot of the dark mode README showing underlines between badge images

Screenshot of the light mode README showing underlines between badge images

Additional Info

GitHub recently changed markdown docs to render the underlines by default (good! accessibility!). This was an issue on hover for links even before then.
@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working :( status: accepting prs Please, send a pull request to resolve this! labels Nov 14, 2023
@5hraddha
Copy link
Contributor

Hi @JoshuaKGoldberg, I would like to fix this bug. Could you please assign this issue to me? Thank you!

@JoshuaKGoldberg
Copy link
Owner Author

👋 @5hraddha, happy you're interested in this! I don't use any kind of issue claiming system: https://github.com/JoshuaKGoldberg/create-typescript-app/blob/62281d8a0c16872eb16bbd12ce44d145e5080748/.github/CONTRIBUTING.md#issue-claiming. But feel free to send a PR if you've got a fix. I'd recommend reading through that contributing guide and its linked development guide to answer common questions about how to send PRs. Cheers!

@5hraddha
Copy link
Contributor

Sure, @JoshuaKGoldberg . That helps. Thank you!

@5hraddha 5hraddha mentioned this issue Nov 14, 2023
Merged
3 tasks
JoshuaKGoldberg pushed a commit that referenced this issue Nov 14, 2023
@5hraddha
fix: remove visual underlines on badge links in README.md (#1030)
e25a47f 
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open issue: fixes #1027
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

This PR removes the visual underlines on badge links in README.md,
introduced by the recent GitHub changes (to render the underlines by
default). The problem was that the `<link>` and `<img>` tags were on
separate lines, thus creating unnecessary spaces in between. These
spaces were rendering empty links with an underline. 💖
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.43.4 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: remove visual underlines on badge links in README.md 5hraddha/create-typescript-app
2 participants
@JoshuaKGoldberg @5hraddha