hub / github.com/withastro/starlight
github.com/withastro/starlight @0.41.3
446 symbols
1,639 edges
266 files
93 documented · 21%
README
Starlight
Starlight is a documentation website framework for Astro.
Documentation
Read the Starlight docs (they’re built with Starlight!)
Support
Get help in the Astro Discord. Post questions in our #support forum with the “starlight” tag, or visit our dedicated #starlight channel to discuss current development and more!
You can also submit bug reports and feature requests as GitHub issues.
Contributing
Join us as a Starlight contributor! These links will help you get started:
License
MIT
Copyright (c) 2023–present Starlight contributors
Extension points exported contracts — how you extend this code
Dir (Interface)* A representation of the route structure. For each object entry: * if it’s a folder, the key is the directory name, an
packages/starlight/utils/navigation.ts
Config (Interface)
(no doc)
docs/__a11y__/test-utils.ts
SidebarState (Interface)
The shape used to persist sidebar state across a user’s session.
packages/starlight/components-internals/SidebarPersistState.ts
ErrorReport (Interface)
(no doc)
docs/__a11y__/reporter.ts
I18n (Interface)
(no doc)
packages/starlight/locals.d.ts
A11yReport (Interface)
(no doc)
docs/__a11y__/reporter.ts
Locals (Interface)
(no doc)
packages/starlight/locals.d.ts
StarlightThemeProvider (Interface)
(no doc)
packages/starlight/global.d.ts
Core symbols most depended-on inside this repo
getSidebarcalled by 45
packages/starlight/utils/navigation.ts
goto
called by 45
packages/starlight/__e2e__/test-utils.ts
render
called by 42
packages/starlight/__tests__/markdown-processor/utils.ts
localizedUrl
called by 39
packages/starlight/utils/localizedUrl.ts
slugToLocaleData
called by 34
packages/starlight/utils/slugs.ts
getPrevNextLinks
called by 24
packages/starlight/utils/navigation.ts
oklchColorFromParts
called by 24
docs/src/components/theme-designer/color-lib.ts
generateStarlightPageRouteData
called by 22
packages/starlight/utils/starlight-page.ts
Shape
Languages
TypeScript100%
Modules by API surface
packages/starlight/utils/navigation.ts34 symbols
packages/starlight/integrations/satteri.ts15 symbols
docs/__a11y__/reporter.ts12 symbols
packages/starlight/user-components/rehype-file-tree.ts11 symbols
packages/starlight/utils/routing/middleware.ts10 symbols
packages/starlight/utils/routing/index.ts10 symbols
packages/starlight/utils/routing/data.ts10 symbols
packages/starlight/utils/error-map.ts10 symbols
packages/starlight/__e2e__/test-utils.ts10 symbols
packages/starlight/utils/slugs.ts9 symbols
packages/starlight/utils/routing/types.ts9 symbols
packages/starlight/utils/path.ts9 symbols
Dependencies from manifests, versioned
@astro-community/astro-embed-youtube0.5.10 · 1×
@astrojs/check0.9.9 · 1×
@astrojs/markdoc2.0.0 · 1×
@astrojs/markdown-remark7.2.0 · 1×
@astrojs/markdown-satteri0.3.2 · 1×
@astrojs/mdx7.0.0 · 1×
@astrojs/node11.0.0 · 1×
@astrojs/sitemap3.7.2 · 1×
@astrojs/starlightworkspace:* · 1×
@astrojs/starlight-markdoc0.7.0 · 1×
@astrojs/starlight-tailwind5.0.0 · 1×
@changesets/changelog-github0.6.0 · 1×
For agents
$ claude mcp add starlight \
-- python -m otcore.mcp_server <graph>