-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
🏗📖 Auto-format all markdown files in ampproject/amphtml
with Prettier
#25182
Conversation
The link checker is reporting several seemingly broken links in our documentation I don't think we should be running the broken links check for PRs that modify a large number (> 20) of markdown files, so I've skipped it for large PRs. The check will continue to run when a smaller number of files are touched. |
I sanity checked several of the changes in this PR, and found no visible changes to the rendered HTML in most cases. This is now ready for review. |
Rebased and added a function to print suggested fixes for badly formatted |
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.
overall changes look fine (with a few comments) though I admit to not reviewing all 483 files in detail :)
Rebased, reverted changes to issue template headers, and exempted them from future checks. |
Some final notes:
Merging this now 🤞 |
The AMP Project already uses Prettier to auto-format JS files and several non-JS files across the repo. This PR adds documentation files to the mix.
Highlights:
.md
files in the list of files that are checked by Prettier.md
files in the repo by runninggulp prettier --fix
.md
filesgulp make-extension
) resilient to markdown file auto-fixingNotes:
.md
files will have to satisfy Prettier's formatting requirements.md
files on save is available heregulp prettify --local_changes --fix
Example of a failing check:
Fixes #25148