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

Prettify HTML documentation #9395

Merged
merged 2 commits into from
Oct 3, 2021
Merged

Prettify HTML documentation #9395

merged 2 commits into from
Oct 3, 2021

Conversation

wbamberg
Copy link
Collaborator

@wbamberg wbamberg commented Sep 30, 2021

This PR prettifies the HTML docs:

npx prettier --write --embedded-language-formatting=off ./files/en-us/web/html

The main effect is:

  • add a blank line after front matter
  • use the - style for lists, rather than *
  • use _ style for <em>, rather than *

I've checked it quite carefully and can't find any errors it's introduced. I did find a few inline Markdown issues that were already present, and fixed them in 652f724.

@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label Sep 30, 2021
@github-actions

This comment has been minimized.

@wbamberg wbamberg changed the title Prettify HTML Oct 1, 2021

This would stop a malicious user from creating a fake form, pretending to be a bank, and emailing the form to unsuspecting users to trick them into transferring money to the wrong place. This kind of attack is called a [Cross Site Request Forgery (CSRF)](/en-US/docs/Learn/Server-side/First_steps/Website_security#cross-site_request_forgery_\(csrf\)); pretty much any reputable server-side framework uses hidden secrets to prevent such attacks.
This would stop a malicious user from creating a fake form, pretending to be a bank, and emailing the form to unsuspecting users to trick them into transferring money to the wrong place. This kind of attack is called a [Cross Site Request Forgery (CSRF)](</en-US/docs/Learn/Server-side/First_steps/Website_security#cross-site_request_forgery_(csrf)>); pretty much any reputable server-side framework uses hidden secrets to prevent such attacks.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is odd but seems to work fine.

@wbamberg wbamberg marked this pull request as ready for review October 1, 2021 21:25
@wbamberg wbamberg requested a review from a team as a code owner October 1, 2021 21:25
@wbamberg wbamberg requested review from estelle and removed request for a team October 1, 2021 21:25
Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spot checked 30 docs, and all looked good.

@wbamberg wbamberg merged commit 7756629 into mdn:main Oct 3, 2021
@wbamberg
Copy link
Collaborator Author

wbamberg commented Oct 3, 2021

Thanks for the review Estelle!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 3, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:HTML Hypertext Markup Language docs
2 participants