starlight-links-validator
starlight-links-validator copied to clipboard
Sidebar hidden pages error as invalid link
Describe the bug
If you configure a page that you don't want to have showing up as a sidebar page.
sidebar:
hidden: true
Then the validation fails even if the links are correct.
validating links
10:09:23 [ERROR] ✗ Found 1 invalid link in 1 file.
10:09:23 ▶ docs/guides/vxlan/nd/learning_lab/building-data-model/
10:09:23 └─ /docs/guides/vxlan/nd/learning_lab/reference/understanding-nd-poap - invalid link
To Reproduce
One a MD document, include:
sidebar:
hidden: true
Then the validation fails for a reference to that page.
Expected behavior
Expect the validation to pass since it is a valid link, just not visible from the sidebar.
How often does this bug happen?
Every time
System Info
No response
Additional Context
No response
Thanks for your feedback :raised_hands:
I've try setting up a reproduction but so far, I'm unable to reproduce a similar behavior.
Would you be able to provide a small reproduction of the issue where the validation fails for such a case?