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

Site-wide topbar for navigation and links #57

Closed
kmike opened this issue Dec 23, 2020 · 2 comments
Closed

Site-wide topbar for navigation and links #57

kmike opened this issue Dec 23, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@kmike
Copy link
Contributor

kmike commented Dec 23, 2020

Is your feature request related to a problem? Please describe.
It'd be nice to have an option for adding a header to the docs.

It can be used to organize navigation in a different way - for example, for having links which are not related directly to the documentation content, important links to related projects, etc. Sometimes it is also a better place for branding (depends on design).

Describe the solution you'd like
Optional header block.

Describe alternatives you've considered

  • Reusing announcement block (hack)
  • overriding page.html template to add a header (good to have something standard, out-of-the-box).
@kmike kmike added the enhancement New feature or request label Dec 23, 2020
@pradyunsg pradyunsg changed the title header support Add support for site-wide headers Dec 23, 2020
@pradyunsg pradyunsg changed the title Add support for site-wide headers Site-wide topbar for navigation and links Dec 28, 2020
@pradyunsg
Copy link
Owner

Thinking out loud and making notes for a future me... There's basically 2 reasons for someone to want a topbar in documentation:

  1. For linking to other resources/projects
  2. For splitting the same project's documentation into multiple sections (tutorials, reference, etc.)

I'm actually inclined to create a new theme that derives from Furo, that's making a few different design choices (like no announcements, different navigation handling, logo going into the header instead of sidebar). That can be biased toward larger/multi-project documentation sets; which is also where I imagine that something like this would be more appealing. This would also cleanly separate the code and different behavior, which is good -- it limits the user-facing configuration that Furo has to have (fewer the number of knobs, the easier it is to use).

@pradyunsg
Copy link
Owner

pradyunsg commented Mar 10, 2021

Closing since I consider this out of scope for Furo.

There's some collaboration work being done with pydata-sphinx-theme (which does have this) as well as various other folks, that'll hopefully result in something nice for this style of content! :)

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

2 participants