-
Notifications
You must be signed in to change notification settings - Fork 27k
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
chore(docs): refactor README.md #70503
Conversation
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
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.
As you say, GitHub I'm not sure why GitHub rich diff shows different preview. |
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.
Ah yea looks like a quirk of the diff view, seems fine in full view
Summary
Remove redundant html element and css.
Add alt text to images.
Both old and new README.md have the same appearance.
Description
I changed some parts.
1. Insert
align="center"
into only top<div>
tagThe all of logo, title, and badges are center.
Then it doesn't need to call at every element.
2. Move
<h1>
tag outside<a>
tagThe title doesn't have link even if inside
<a>
tag when it's wrapped heading element.So put it out for the readability.
3. Use image alt text instead of aria-label
Alt text is displayed on the page if the images can't be loaded.
That's why I prefer alt text to aria-label.
In addition, the screen reader still reads the same words after updating.
Improving Documentation
pnpm prettier-fix
to fix formatting issues before opening the PR.x-ref: <img>: The Image Embed element | mdn web docs