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 config option to disable Blog link in top navbar #108

Closed
wants to merge 1 commit into from

Conversation

rambleraptor
Copy link

Describe the pull request

This creates a new config option that allows you to stop the "Blog" link from appearing in the navbar.

Why

With the existance of starlight-sidebar-topics, the blog can be accessed through the sidebar. In my website, I'd like to stick with the normal navbar and not use the new theme selector.

How
Added config option and plumbed through.

Screenshots

Copy link

changeset-bot bot commented Jan 3, 2025

⚠️ No Changeset found

Latest commit: e592bcb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jan 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
starlight-blog-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 3, 2025 11:21pm

@HiDeoo
Copy link
Owner

HiDeoo commented Jan 4, 2025

Thanks for the contribution 🙌

I am currently exploring various possibilities to customize how and where the blog link is actually displayed, as users have requested different options for this. I am not sure yet how this will be implemented/configurable so I don't think I want to add a new option for this yet that I'll probably have to deprecate later.

There are also some important changes coming to Starlight that will highly change how this plugin is structured, e.g. the entire Sidebar override will probably be removed soon and also potentially make both plugins easier to use at the same time as it's not that easy right now.

I guess one possible workaround for now could be to add a custom override for the ThemeSelect component in your Astro configuration, and just render the default Starlight one which would remove the blog link.

I'm definitely taking note that on top of multiple options, some users might want to have no link at all and have full control over it 👍

@HiDeoo HiDeoo closed this Jan 4, 2025
@rambleraptor
Copy link
Author

Any ideas on when the Sidebar override will be removed? I'm really keen to try and get starlight-sidebar-topics implemented with the blog plugin.

@HiDeoo
Copy link
Owner

HiDeoo commented Jan 21, 2025

As withastro/starlight#2390 is required, I would suggest subscribing to it as once merged and released, it would be a good indicator that the refactor can be started.

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

Successfully merging this pull request may close these issues.

2 participants