Configuration

The Starlight GitHub Alerts plugin can be configured inside the astro.config.mjs configuration file of your project:

astro.config.mjs

// @ts-check
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightGitHubAlerts from 'starlight-github-alerts'

export default defineConfig({
  integrations: [
    starlight({
      plugins: [
        starlightGitHubAlerts({
          // Configuration options go here.
        }),
      ],
      title: 'My Docs',
    }),
  ],
})

Plugin configuration

The Starlight GitHub Alerts plugin accepts the following configuration options:

types

Defines the mapping used to convert GitHub alert types to Starlight aside types.

caution

Type: 'caution' | 'danger' | 'note' | 'tip'
Default: 'danger'

Sets the Starlight aside type used to render GitHub note alerts.

important

Type: 'caution' | 'danger' | 'note' | 'tip'
Default: 'caution'

Sets the Starlight aside type used to render GitHub important alerts.

note

Type: 'caution' | 'danger' | 'note' | 'tip'
Default: 'note'

Sets the Starlight aside type used to render GitHub note alerts.

tip

Type: 'caution' | 'danger' | 'note' | 'tip'
Default: 'tip'

Sets the Starlight aside type used to render GitHub tip alerts.

warning

Type: 'caution' | 'danger' | 'note' | 'tip'
Default: 'caution'

Sets the Starlight aside type used to render GitHub warning alerts.