StarlightDocsEntry type to be exported

[ThePlenkov]

What version of starlight are you using?

0.32.3

What is your idea?

HI!

I'm writing a custom loader which should return starlight compatible document

For that reason I'd like to reuse the type StarlightDocsEntry which is not exported by the plugin currently.

Can we fix that please?

Thanks!

Why is this feature necessary?

This is needed to be able to write compatible with a current version plugins ( like custom docLoaders )

Do you have examples of this feature in other projects?

No response

Participation

• I am willing to submit a pull request for this feature.

[delucis]

Hmm, I don’t think we can easily do that as StarlightDocsEntry itself depends on the CollectionEntry<'docs'> type so using it in a loader would be a bit circular.

I think the correct approach might be to use the docsSchema() instead to validate the entry? And if you need the expected input type for that, you could use Zod’s type utilities (it’s a bit clunky admittedly):

import { z } from 'astro/zod';
import { docsSchema } from '@astrojs/starlight/schema';

type EntryInput = z.input<ReturnType<ReturnType<typeof docsSchema>>>;

[delucis]

Thanks. What scripts do I need to run to do a build?

[ThePlenkov]

npx nx build starlight

[delucis]

Thanks. I was able to reproduce it and shared with a few people but I’m not quite sure what’s going on. I’ve never used Nx before and there’s a few more things at play here like swc and Rollup configuration, so it’s a bit tricky to debug.

[ThePlenkov]

i think the error comes more from rpt2 plugin. I'm quite sure is possible to reproduce it without nx. However also important to mention - I was able to solve my issue by using tsdown ( which is backed by rolldown ).

[delucis]

Ah cool, good to know.