Skip to content

Add frontmatter to hide page from sidebar autogeneration #441

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
merged 11 commits into from
Aug 10, 2023
Merged

Add frontmatter to hide page from sidebar autogeneration #441

merged 11 commits into from
Aug 10, 2023

Conversation

@lorenzolewis
Copy link
Contributor

@lorenzolewis lorenzolewis commented Aug 1, 2023

What kind of changes does this PR include?

  • Changes to Starlight code

Description

@lorenzolewis
initial hidden sidebar poc
9dc1ab6 
Signed-off-by: Lorenzo Lewis <[email protected]>
@lorenzolewis
add changeset
735ed74 
Signed-off-by: Lorenzo Lewis <[email protected]>
@lorenzolewis
add docs
4e8e7ee 
Signed-off-by: Lorenzo Lewis <[email protected]>
@lorenzolewis
add default to docs
9e6674b 
Signed-off-by: Lorenzo Lewis <[email protected]>
@changeset-bot
Copy link

changeset-bot bot commented Aug 1, 2023 •
edited
Loading

🦋 Changeset detected

Latest commit: 618fbae

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@astrojs/starlight Minor

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added 📚 docs Documentation website changes 🌟 core Changes to Starlight’s main package labels Aug 1, 2023
@netlify
Copy link

netlify bot commented Aug 1, 2023 •
edited
Loading

✅ Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 618fbae
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/64d4a97f0adc5f0009647740
😎 Deploy Preview https://deploy-preview-441--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

HiDeoo
HiDeoo reviewed Aug 1, 2023
View reviewed changes
Copy link
Member

@HiDeoo HiDeoo left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Super neat, left a few comments.

Hides this page from being included in an autogenerated sidebar group.

I wonder if we should somehow emphasize this is not a draft mode and that the page will still be generated. Or maybe it's already obvious and I'm a little bit paranoid ^^

lorenzolewis and others added 4 commits August 1, 2023 10:08
@lorenzolewis
Copy link
Contributor Author

lorenzolewis commented Aug 1, 2023

Got those changes in.

RE: the phrasing, I tried to reference that it would hide it from any navigation/autogenerated sidebar in the docs so I feel like it avoids that confusion. But also open to any suggestions to adapt that.

@delucis delucis added the 🌟 minor Change that triggers a minor release label Aug 1, 2023
delucis
delucis reviewed Aug 1, 2023
View reviewed changes
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Looks good @lorenzolewis — thank you! Left some small comments, but implementation and testing all look spot on.

lorenzolewis and others added 2 commits August 1, 2023 12:54
@lorenzolewis @delucis
Update packages/starlight/schema.ts
37bde6c 
Co-authored-by: Chris Swithinbank <[email protected]>
@lorenzolewis @delucis
Apply suggestions from code review
5b04fff 
Co-authored-by: Chris Swithinbank <[email protected]>
@lorenzolewis lorenzolewis requested a review from delucis August 1, 2023 11:54
delucis
delucis approved these changes Aug 4, 2023
View reviewed changes
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Thanks again @lorenzolewis! I think this looks good — we’ll get it out in the next minor release 🙌

@delucis delucis merged commit 0119a49 into withastro:main Aug 10, 2023
@astrobot-houston astrobot-houston mentioned this pull request Aug 10, 2023
Merged
@lorenzolewis lorenzolewis deleted the feat/hide-sidebar branch August 10, 2023 09:59
@morinokami morinokami mentioned this pull request Aug 19, 2023
Merged
Yoxnear pushed a commit to Yoxnear/starlight-custom that referenced this pull request Jul 23, 2025
@lorenzolewis @HiDeoo @delucis
Add frontmatter to hide page from sidebar autogeneration (withastro#441)
a34da10 
Co-authored-by: HiDeoo <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@HiDeoo HiDeoo HiDeoo left review comments

@delucis delucis delucis approved these changes

Assignees

No one assigned

Labels

🌟 core Changes to Starlight’s main package 📚 docs Documentation website changes 🌟 minor Change that triggers a minor release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Set sidebar title and hide pages from autogenerated sidebar

3 participants

@lorenzolewis @delucis @HiDeoo