-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Shall we auto-format our .md files with Prettier? #25148
Copy link
Copy link
Closed
Description
Today, we use Prettier to format and fix all our JS files and several non-JS files. The format checker has supported Markdown files for a while now.
Question: Shall we start auto-formatting our .md files with Prettier?
Pros:
- One single standard for the internal structure of documentation files
- IDE support for auto-fix-on-save while editing code
- Command line support for auto-fixing local changes
- Possible to override Prettier's auto-format behavior for sections of code
- Possible to auto-wrap text for easy editing
Cons:
-
There might be some small changes to how
.mdfiles look when they are rendered- Attribute lists are changed to all-in-one-line if they all fit on one line

- Attribute lists are changed to one-per-line if they don't all fit on one line

- Attribute lists are changed to all-in-one-line if they all fit on one line
-
Failing
gulp prettifychecks can be annoying if an occasional contributor makes a badly formatted change -
No easy way to auto-format code with Prettier if you edit code with the GitHub web-UI
@CrystalOnScript @mrjoro @pbakaus @ampproject/wg-outreach Thoughts?
Reactions are currently unavailable