starlight
Astro Starlight formatter for GraphQL documentation output.
Produces MDX compatible with Astro Starlight using its native Aside and Badge components. Includes lifecycle hooks for generating index files for each category directory.
mdxDeclaration
const mdxDeclaration: MDXString;
Defined in: starlight/index.ts:43
MDX import statement prepended to every generated file to register Starlight components.
mdxExtension
const mdxExtension: ".mdx";
Defined in: starlight/index.ts:40
File extension used for generated pages.
afterRenderTypeEntitiesHook()
function afterRenderTypeEntitiesHook(event): Promise<void>;
Defined in: starlight/index.ts:120
Lifecycle hook that appends a link entry to the category index.md
after each type entity page is rendered.
Parameters
event
Hook payload containing the entity name and its output file path
data
{
filePath: string;
name: string;
}
data.filePath
string
data.name
string
Returns
Promise<void>
beforeGenerateIndexMetafileHook()
function beforeGenerateIndexMetafileHook(event): Promise<void>;
Defined in: starlight/index.ts:100
Lifecycle hook that creates an index.md file for a category directory
before Starlight indexes it. Skips creation if the file already exists.
Parameters
event
Hook payload containing the target directory and category name
data
{
category: string;
dirPath: string;
}
data.category
string
data.dirPath
string
Returns
Promise<void>
createMDXFormatter()
function createMDXFormatter(_meta?): Formatter;
Defined in: starlight/index.ts:137
Creates an Astro Starlight formatter.
Parameters
_meta?
Maybe<MetaInfo>
Unused metadata parameter
Returns
Formatter
A complete Formatter implementation for Starlight MDX output
formatMDXAdmonition()
function formatMDXAdmonition(admonition, _meta): MDXString;
Defined in: starlight/index.ts:65
Formats an admonition using the Starlight <Aside> component.
Maps warning type to caution; all other types use note.
Parameters
admonition
AdmonitionType
Admonition data with text, title, and type
_meta
Maybe<MetaInfo>
Unused metadata parameter
Returns
MDXString
Formatted Starlight Aside component string
formatMDXBadge()
function formatMDXBadge(badge): MDXString;
Defined in: starlight/index.ts:53
Formats a badge using the Starlight <Badge> component.
Maps DEPRECATED classname to the caution variant; all others use default.
Parameters
badge
Badge
Badge data containing text and optional classname
Returns
MDXString
Formatted Starlight Badge component string
formatMDXLink()
function formatMDXLink(link): TypeLink;
Defined in: starlight/index.ts:78
Appends .mdx to internal link URLs.
Parameters
link
TypeLink
Link data with URL and text
Returns
TypeLink
Link with .mdx extension appended to the URL