From 1d1b846a89f1316ad190be97bd472db61d4f03e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=9E=E3=83=AB=E3=82=B3=E3=83=A1?= Date: Wed, 2 Oct 2024 10:40:43 +0900 Subject: [PATCH] chore(docs): refactor README.md (#70503) # 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 `
` tag The all of logo, title, and badges are center. Then it doesn't need to call at every element. ### 2. Move `

` tag outside `` tag The title doesn't have link even if inside `` 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 - [x] Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - [x] Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide x-ref: [\: The Image Embed element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img) | mdn web docs --------- Co-authored-by: JJ Kasper --- packages/next/README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/packages/next/README.md b/packages/next/README.md index 8705a2fb068be..516610154f59e 100644 --- a/packages/next/README.md +++ b/packages/next/README.md @@ -1,19 +1,18 @@ -

+

- + Next.js logo -

Next.js

-

- -

- - - - -

+

Next.js

+ +Vercel logo +NPM version +License +Join the community on GitHub + +
## Getting Started