[docs] Format english markdown files #21463
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
Details of bundle changes.Comparing: a8b54b7...8bfa773 Details of page changes
|
eps1lon
force-pushed
the
chore/format-markdown
branch
from
a31489c to
c008b55
Compare
| React.forwardRef((linkProps, ref) => ( | ||
| <Link ref={ref} to={to} {...linkProps} /> | ||
| )), | ||
| () => React.forwardRef((linkProps, ref) => <Link ref={ref} to={to} {...linkProps} />), |
There was a problem hiding this comment.
It almost got out of the screen (notice the scrollbar):
We might want to reduce the max-length for the markdown. However, having a look at the most frequent screen widths, my Macbook Pro 13" and its 1280px seems to be in the lower range of the distribution.
There was a problem hiding this comment.
Reduced to 60 characters for docs/**/*.md: https://deploy-preview-21463--material-ui.netlify.app/guides/composition/
There was a problem hiding this comment.
@oliviertassinari This is also an issue for demos. I think we should fix them in this PR as well to reduce diff noise. Basically apply printWidth: 60 to 'docs/src/pages/**/*.{js,tsx}'
oliviertassinari
approved these changes
Jun 16, 2020
mbrookes
approved these changes
Jun 16, 2020
|
Merging before we get a conflict :) |
|
Which would've been my problem. There was still an open issue |
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.
Closes #14792
Need to check each diff visually. We had some formatting that was only working in our docs but wasn't actually working in other markdown formatters like we think it did (e.g. GitHub, prettier). The plan is that each visual diff in github shows "no visible changes here" (visual code changes should be fine).Looks goodNote:
Prettier requires 3 spaces instead of 2 for codeblocks and paragraphs that belonged to listitem. We indented them with 2 spaces. They need to be indented by 3:
Before
Valid render:
an item
After:
Valid render:
an item