-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Format all Markdown files using Prettier #11143
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
Conversation
💖 Thanks for opening this pull request! 💖 Here is a list of things that will help get it across the finish line:
|
| zh | Chinese | | ||
| zh-CN | Chinese (Simplified) | | ||
| zh-TW | Chinese (Traditional) | | ||
| zu | Zulu | |
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.
This is just beautiful :D
"printWidth": 80, | ||
"proseWrap": false, | ||
"semi": false, | ||
"singleQuote": true |
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.
These are the options that are used for Markdown and the code inside the fences. For more options check the full list: https://prettier.io/docs/en/options.html
Hi! We appreciate the contribution here but we have our own markdown linter and don’t use prettier as a format standard within our js. This PR unfortunately breaks our markdown parser and so at this time this isn’t something we think we can integrate. |
Closing due to incompatibility with our markdown parser. Feel free to reopen if there is a way to make it work with our markdown parser. |
Are you guys talking about the
Which means that it is not actually formatting the markdown files but only the code inside of them. What Prettier does on the other hand.. is actually normalising all the files and keeps the consistency among all of them. On top of that it also out of the box formats the code inside as well and I simply modified the options to match the So basically Prettier does what standard-markdown is doing plus formatting the actual file. |
I'm suggesting reconsider and of course I'm fully aware that the standard formatting is being used, but this PR is not affecting anything more than the Markdown files.. |
@lipis we do several things with our markdown files:
You can test all three of these by running |
OKey.. I'll take another look.. :) |
So I'm getting these errors and there is no such option in Prettier.. is that really so important.. or this can be skipped?
|
@lipis yup... they are important as they are needed in the generation of the api file and typescript definitions. |
Prettier is now supporting Markdown since v1.8.0 and also formats the code inside the fences.
https://prettier.io
If something is actually breaking or it's wrong, please let me know as we can add a few ignore blocks in that case.