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

Support for icon links for social, github, external links, etc #362

Open
choldgraf opened this issue Apr 16, 2024 · 0 comments
Open

Support for icon links for social, github, external links, etc #362

choldgraf opened this issue Apr 16, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Contributor

It would be useful if MyST sites could link out to other websites via the theme's user interface. This would allow communities to define other external links that are relevant across the entire site.

It is common for links like this to be represented with small, standardized icons, and to provide users the ability to both choose the icon and the external link.

This often goes in either the navigation bar at the top, or the primary sidebar.

Examples in the wild

The mystmd.org website implements its own custom icon links widget in the top-right (these are hidden on mobile)

image

The Sphinx Book Theme implements icon links in the left sidebar (these are visible on mobile in the left drawer)

image

The PyData Sphinx Theme implements icon links in the navigation bar (these are visible on mobile in the left drawer)

CleanShot 2024-04-16 at 11 32 29@2x

@choldgraf choldgraf added the enhancement New feature or request label Apr 16, 2024
@choldgraf choldgraf changed the title Support for icon links Support for icon links for social, github, external links, etc Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant