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

Export StarlightUserConfig type #1278

Merged
merged 1 commit into from
Dec 17, 2023

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Dec 15, 2023

What kind of changes does this PR include?

  • Changes to Starlight code

Description

I've been finding myself often writing the following type when working on plugins and having to pass down the received Starlight user config to a function that needs multiple of its properties:

type StarlightUserConfig = Parameters<StarlightPlugin['hooks']['setup']>['0']['config']

This PR exports this type which is already referenced multiple times in the "Plugins reference" page of the docs.

Copy link

changeset-bot bot commented Dec 15, 2023

🦋 Changeset detected

Latest commit: a86bff0

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 Patch

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

Copy link

vercel bot commented Dec 15, 2023

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

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Dec 15, 2023 4:01pm

@github-actions github-actions bot added the 🌟 core Changes to Starlight’s main package label Dec 15, 2023
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.

LGTM! Thanks @HiDeoo 🌟

@delucis delucis merged commit e88abb0 into withastro:main Dec 17, 2023
9 checks passed
@astrobot-houston astrobot-houston mentioned this pull request Dec 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟 core Changes to Starlight’s main package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants