Skip to content
Page

Starlight components

Starlight's own content components keep working, and the theme draws them with RefineUI tokens.

Pages can mix Starlight’s built-in components with RefineUI components. The theme restyles the built-in ones with the same tokens, so both sets look alike.

Asides

Section titled “Asides”

Badges

Section titled “Badges”
Default Note Tip Caution Danger Success

Tabs

Section titled “Tabs”
Terminal window
bun add @pelagornis/page

Steps

Section titled “Steps”

  1. Install the plugin.

  2. Add pagePlugin() to Starlight’s plugins.

  3. Run the dev server.

Cards

Section titled “Cards”

Shell

Header, sidebar, search, and footer come from RefineUI.

Components

Every RefineUI component is exported from @pelagornis/page/components.

Getting StartedInstall the theme and register the plugin.

File tree

Section titled “File tree”
  • astro.config.ts
  • markdoc.config.mjs
  • Directorysrc/
    • Directorycontent/
      • Directorydocs/
        • index.mdx
        • Directoryguides/
          • getting-started.mdx