[skip changelog] Prevent Prettier from wrapping nightly download link definitions #901
Conversation
This file contains hidden or 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
Prettier is configured to wrap lines in Markdown files at 120 characters. The reference definitions for the nightly ARM downloads happen to be longer than 120 characters, and so get wrapped. With the modern Markdown specification, this is permitted: https://spec.commonmark.org/0.29/#link-reference-definitions > A link reference definition consists of a link label, indented up to three spaces, followed by a colon (:), optional whitespace (including up to one line ending), a link destination but apparently the Python-Markdown renderer used by MkDocs does not support this. The solution is to remove the line breaks and markup to instruct Prettier to ignore these lines: https://prettier.io/docs/en/ignore.html#markdown
per1234
added
topic: documentation
silvanocerza
approved these changes
Aug 18, 2020
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
Bug fix.
Prettier is configured to wrap lines in Markdown files at 120 characters. The reference definitions for the nightly ARM download links happen to be longer than 120 characters, and so get wrapped.
With the modern Markdown specification, this is permitted:
https://spec.commonmark.org/0.29/#link-reference-definitions
but apparently the Python-Markdown renderer used by MkDocs does not support this, so these links are broken.
The links are fixed by remove the line breaks added by Prettier and add markup to instruct Prettier to ignore these lines so the auto formatter won't reintroduce the issue:
https://prettier.io/docs/en/ignore.html#markdown
No.