Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(v2): add icon to generic sidebar link #4261

Merged
merged 1 commit into from
Feb 22, 2021

Conversation

lex111
Copy link
Contributor

@lex111 lex111 commented Feb 21, 2021

Motivation

I've noticed that many docs sites have external links in the sidebar that are visually different from the usual ones.
Typically an icon serves as a visual marker for external link, so I added one to the corresponding sidebar item type.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

image

{
  type: 'link',
  label: 'External link',
  href: 'https://example.com',
},

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.)

@lex111 lex111 added the pr: new feature This PR adds a new API or behavior. label Feb 21, 2021
@lex111 lex111 requested a review from slorber as a code owner February 21, 2021 12:27
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Feb 21, 2021
@github-actions
Copy link

Size Change: +489 B (0%)

Total Size: 544 kB

Filename Size Change
website/build/assets/css/styles.********.css 87 kB +489 B (+1%)
ℹ️ View Unchanged
Filename Size Change
website/build/assets/js/main.********.js 370 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 60.5 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B
website/build/index.html 25.6 kB 0 B

compressed-size-action

@netlify
Copy link

netlify bot commented Feb 21, 2021

Deploy preview for docusaurus-2 ready!

Built with commit 8591df9

https://deploy-preview-4261--docusaurus-2.netlify.app

@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟢 Performance 90
🟢 Accessibility 96
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4261--docusaurus-2.netlify.app/classic/

@netlify
Copy link

netlify bot commented Feb 21, 2021

[V1] Deploy preview success

Built with commit 8591df9

https://deploy-preview-4261--docusaurus-1.netlify.app

@slorber
Copy link
Collaborator

slorber commented Feb 22, 2021

why not :)

Not sure everybody will like that but it is easy to disable so let's merge

@slorber slorber merged commit be871b2 into master Feb 22, 2021
@lex111 lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 2021
This was referenced Mar 10, 2021
@samj
Copy link

samj commented Apr 30, 2024

@slorber
Copy link
Collaborator

slorber commented Apr 30, 2024

@samj every single Docusaurus component can be ejected and overridden. You can swizzle --eject and customize that code, removing the icon if you want to.

Swizzle:

  • DocSidebarItemLink for doc sidebar links
  • NavbarNavLink for navbar links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: new feature This PR adds a new API or behavior.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants