peteretelej/Starlight Action
Build a Starlight documentation site from your Markdown files - zero config required
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| docs | Path to the Markdown documentation folder | no | docs/ |
| title | Site title shown in header and browser tab (defaults to repo name) | no | — |
| description | Site meta description (defaults to repo description) | no | — |
| logo | Path to a logo file (SVG/PNG) to display in the header | no | — |
| readme | If true, include README.md as the landing page and resolve its links | no | false |
| base | Base path override (defaults to /<repo-name>, set to / for custom domains) | no | — |
| config | Path to a partial Starlight config file (JSON) that gets merged with the generated config | no | — |
| custom_css | Comma-separated list of CSS file paths to include as custom styles (e.g., "docs/styles/colors.css, docs/styles/layout.css") | no | — |
| theme | Optional npm package name for a Starlight theme (e.g., starlight-theme-rapide, @catppuccin/starlight) | no | — |
| theme_plugin | Export name for the theme plugin. Use { name } for named exports, or plain name for default exports (e.g., starlightThemeRapide or { ion }) | no | — |
| theme_options | Optional JSON object with theme configuration options | no | — |
| astro_version | Astro version range override (e.g., '^6.0.0'). Only use this to unblock builds when the default version is incompatible. | no | — |
| starlight_version | Starlight version range override (e.g., '~0.38.0'). Only use this to unblock builds when the default version is incompatible. | no | — |
Outputs
no outputs