Skip to content

feat: add support for adding a Banner #208

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.

Sign up for GitHub

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

Jump to bottom
Merged
atinux merged 5 commits into from
Dec 10, 2025
Merged

feat: add support for adding a Banner #208

atinux merged 5 commits into from
Dec 10, 2025

Conversation

@atinux
Copy link
Member

@atinux atinux commented Dec 10, 2025

With this, to add a banner at the top of the website, the user can use the .docs/app/app.config.ts:

export default defineAppConfig({
  docs: {
    banner: {
      title: 'Banner Title',
      icon: 'i-heroicons-information-circle',
      close: true,
      actions: [
        {
          label: 'Learn More',
          to: '/banner',
          variant: 'outline',
        },
      ],
    },
  },
})

See https://ui.nuxt.com/docs/components/banner#props for the props

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 10, 2025 •
edited
Loading

Deploying undocs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3e10473
Status:⚡️  Build in progress...

View logs

pi0
pi0 approved these changes Dec 10, 2025
View reviewed changes
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@pi0
Copy link
Member

pi0 commented Dec 10, 2025

Would be nice to also update json schema for auto complete

@atinux
Copy link
Member Author

atinux commented Dec 10, 2025 •
edited
Loading

Actually I am relying on the app.config.ts here instead of the .config/docs.yml

EDIT: I see that it should work anyway, will add types

@atinux atinux merged commit 8f57edc into main Dec 10, 2025
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pi0 pi0 pi0 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@atinux @pi0