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

Add banners and announcement bars #509

Open
Tracked by #189
choldgraf opened this issue Jan 4, 2025 · 0 comments
Open
Tracked by #189

Add banners and announcement bars #509

choldgraf opened this issue Jan 4, 2025 · 0 comments

Comments

@choldgraf
Copy link
Contributor

choldgraf commented Jan 4, 2025

In Jupyter Book 1, users can create banners via their config file. These are displayed at the top of the site and are used to provide highly-noticeable messages to users. For example, below is a screenshot of the banner we use to tell users about the upcoming Jupyter Book 2:

Image

Suggested functionality

The old implementation used raw HTML in the config to populate the banner, I think it'd be better if this used MyST markdown that was parsed at build time.

If straightforward, users should have the ability to dismiss the banner and have that propagate throughout pages (in both server- and static-forms of browsing)

Thought on priority

I think that this should be supported as part of a Jupyter Book 2 beta, if anything because we'll want that banner to give people an informative "heads up" once we make the switch for the latest branch on ReadTheDocs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needed for beta
Development

No branches or pull requests

1 participant