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

Allow authors to add extra links to the top of pages #606

Open
choldgraf opened this issue May 19, 2020 · 0 comments
Open

Allow authors to add extra links to the top of pages #606

choldgraf opened this issue May 19, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Collaborator

choldgraf commented May 19, 2020

Many themes allow users to configure some extra external links that are in the documentation. For example, the pydata sphinx theme adds "social links" to the top right:

image

In Jupyter Book you can add external links to your _toc.yml file, but this feels like a different use-case from the one I describe above. I think we could use the top-bar for something like this, but the question is whether it's worth supporting.

Do we want to support people adding:

  • extra, arbitrary links to the top-bar (perhaps with a "link icon" dropdown)
  • special outside links like "Twitter" or "GitHub" with their icons

There's a prototype for links here: executablebooks/sphinx-book-theme#97

demo: https://297-244496643-gh.circle-artifacts.com/0/html/index.html

would love to know what folks think

@choldgraf choldgraf added the enhancement New feature or request label May 19, 2020
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