Extract credits into a dedicated overridable component #3933
trueberryless
started this conversation in
Feature Requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
What version of
starlightare you using?0.39.2
What is your idea?
I would like to propose that we extract the credits code and associated styles into a dedicated new component, which is overridable by the consumer.
Question(s) for discussion
How do we handle the overlap with the
creditsconfiguration option? Should this check stay outside of the new component or be moved inside the new component?I see pros and cons for both sides:
creditsto true, which avoids confusion.creditsoption becomes completely useless when the user removes it in their override. And if the user does not override and has credits disabled, we render an empty component.Why is this feature necessary?
If I would like to not only credit Starlight as a documentation framework, but also e.g. Netlify as the deployment platform for my website, I currently have to override the whole
Footercomponent, which includes many other components.I think it makes sense to extract the credits in their own component because all other elements in the Footer have separate components too, so it also cleans up the footer.
Do you have examples of this feature in other projects?
No response
Participation
All reactions