misc: add command to run prettier on docs #2102
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for docusaurus-2 ready! Built with commit 14e61ce |
|
Deploy preview for docusaurus-preview ready! Built with commit 14e61ce |
endiliey
suggested changes
Dec 7, 2019
| @@ -17,6 +17,7 @@ | |||
| "postinstall": "yarn tsc", | |||
| "prettier": "prettier --config .prettierrc --write \"**/*.{js,ts}\"", | |||
| "prettier:diff": "prettier --config .prettierrc --list-different \"**/*.{js,ts}\"", | |||
| "prettier-docs": "prettier --config .prettierrc --write \"**/*.md\"", | |||
There was a problem hiding this comment.
Not in precommit / ci ?
How about mdx
There was a problem hiding this comment.
Not in precommit/ci?
I was undecided about this. But I guess adding to precommit is ok as long as it doesn't fail the CI because of misformatting.
How about mdx?
I initially tried it but there's an issue prettier/prettier#7041 where Prettier doesn't work with MDX. It's fixed in prettier/prettier#6949 but not released yet. When we upgrade Prettier to the next release we can try including support for prettifying MDX.
endiliey
approved these changes
Dec 8, 2019
endiliey
added
pr: maintenance
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Better formatting for our Markdown files.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Netlify previews.
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)