-
Notifications
You must be signed in to change notification settings - Fork 327
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
Display banner for versioned docs #1217
base: main
Are you sure you want to change the base?
Conversation
Use the banner parameter to display a message for old versioned docs: https://docusaurus.io/docs/versioning#configuring-versioning-behavior
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Can you give an example of where you want to use this? we already have some custom version-specific banners |
I’d prefer to do this in a different test. Check out how it looks sit. This patch on 4.1 for example |
Hi @andrewnicols!
Docusaurus implements this with the banner setting, so the patch is enabling this, to display a banner at the top of all the versioned doc pages: |
Compare against the message here: https://moodledev.io/general/releases/4.1 this is what I want to show as it has version-specific information and is factually incorrect. it is not correct to say that 4.5 is “no longer actively maintained”. If I recall the existing banner shown here is meant to be shown on all pages of versioned docs and something has broken that. The Docusaurus banner is too limiting. |
William Entriken requested this at https://tracker.moodle.org/browse/MDLSITE-7820. To implement it, we're taking advantage of the banner setting: https://docusaurus.io/docs/versioning#configuring-versioning-behavior.