[SEO 16.] Add nofollow to docusaurus external links #227
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
3v0k4
approved these changes
Jan 17, 2025
|
|
||
| export default function EditThisPage({editUrl}: Props): JSX.Element { | ||
| return ( | ||
| <Link to={editUrl} className={ThemeClassNames.common.editThisPage} rel="nofollow noopener noreferrer"> |
There was a problem hiding this comment.
suggestion
I see that the current link on our docs has also target=_blank. Will it stay the same? Does Link take care of that internally?
There was a problem hiding this comment.
I see that the current link on our docs has also target=_blank. Will it stay the same?
Yes.
Does Link take care of that internally?
Yes.
Comment on lines
+15
to
+21
| <> | ||
| <A | ||
| {...props} | ||
| rel={isExternal ? 'nofollow noopener noreferrer' : undefined} | ||
| target={isExternal ? '_blank' : undefined} | ||
| /> | ||
| </> |
There was a problem hiding this comment.
suggestion
You don't need the wrapping element:
Suggested change
| <> | |
| <A | |
| {...props} | |
| rel={isExternal ? 'nofollow noopener noreferrer' : undefined} | |
| target={isExternal ? '_blank' : undefined} | |
| /> | |
| </> | |
| <A | |
| {...props} | |
| rel={isExternal ? 'nofollow noopener noreferrer' : undefined} | |
| target={isExternal ? '_blank' : undefined} | |
| /> |
There was a problem hiding this comment.
It was generated this way by:
➜ docusaurus git:(main) npm run swizzle
> [email protected] swizzle
> docusaurus swizzle
------------------------------------------------------------------------------------------------------------------------------------------------
Update available 3.6.3 → 3.7.0
To upgrade Docusaurus packages with the latest version, run the following command:
`npm i @docusaurus/core@latest @docusaurus/plugin-client-redirects@latest @docusaurus/preset-classic@latest @docusaurus/tsconfig@latest
@docusaurus/module-type-aliases@latest`
------------------------------------------------------------------------------------------------------------------------------------------------
✔ Select a theme to swizzle: › @docusaurus/theme-classic
✔ Which language do you want to use? › TypeScript
✔
Select or type the component to swizzle.
* = not safe for all swizzle actions
› MDXComponents/A (Safe)
✔ Which swizzle action do you want to do? › Wrap (Safe)
[SUCCESS]
The original code generated:
import React from 'react';
import A from '@theme-original/MDXComponents/A';
import type AType from '@theme/MDXComponents/A';
import type {WrapperProps} from '@docusaurus/types';
type Props = WrapperProps<typeof AType>;
export default function AWrapper(props: Props): JSX.Element {
return (
<>
<A {...props} />
</>
);
}I'd keep it as is just to be on the safe side.
Co-authored-by: Riccardo <[email protected]>
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.
Use swizzling to replace original Docusaurus components:
https://docusaurus.io/docs/swizzling/
MDXComponents/Acomponent to add nofollow (it's safe)EditThisPagecomponent to override it (it's unsafe if there is a breaking change then we would have to update it). We added rel nofollow.