docs: ensure all links are on a single line #42235
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
electron-cation
bot
added
documentation 📓
semver/patch
erickzhao
added
target/30-x-y
dsanders11
approved these changes
May 21, 2024
There was a problem hiding this comment.
@erickzhao, I don't feel strongly about it, but alternatively we can skip the rule for certain files (CONTRIBUTING.md, README.md, docs/breaking-changes.md) which aren't rendered on the website using <!-- markdownlint-disable-file no-newline-in-links --> at the bottom of those files.
VerteDinde
approved these changes
May 22, 2024
|
No Release Notes |
This was referenced May 28, 2024
|
I have automatically backported this PR to "31-x-y", please check out #42298 |
trop
bot
added
in-flight/31-x-y
and removed
target/31-x-y
|
I have automatically backported this PR to "30-x-y", please check out #42299 |
trop
bot
added
in-flight/30-x-y
merged/30-x-y
1 task
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.
Description of Change
Due to a bug in Docusaurus 3 (facebook/docusaurus#9048), having links on multiple lines will break relative linking in the website build process.
This PR changes some whitespace around to fix all instances of this case in the Electron docs. These instances were vetted with electron/lint-roller@f68f469 (thanks @dsanders11!), which will be applied to this repository in a separate PR.
cc @electron/docs
Release Notes
Notes: none