github withastro/starlight @astrojs/starlight@0.26.0

latest releases: @astrojs/starlight-docsearch@0.3.0, @astrojs/starlight@0.29.0, @astrojs/starlight@0.28.6...
2 months ago

Minor Changes

  • #1784 68f56a7 Thanks @HiDeoo! - Adds <LinkButton> component for visually distinct and emphasized call to action links

  • #2150 9368494 Thanks @delucis! - Adds state persistence across page navigations to the main site sidebar

  • #2087 caa84ea Thanks @HiDeoo! - Adds persistence to synced <Tabs> so that a user's choices are reflected across page navigations.

  • #2051 ec3b579 Thanks @HiDeoo! - Adds a guideline to the last step of the <Steps> component.

    If you want to preserve the previous behaviour and hide the guideline on final steps, you can add the following custom CSS to your site:

    /* Hide the guideline for the final step in <Steps> lists. */
    .sl-steps > li:last-of-type::after {
      background: transparent;
    }
  • #1784 68f56a7 Thanks @HiDeoo! - Changes the hero component action button default variant from minimal to primary.

    ⚠️ BREAKING CHANGE: If you want to preserve the previous appearance, hero component action buttons previously declared without a variant will need to be updated to include the variant property with the value minimal.

    hero:
      actions:
        - text: View on GitHub
          link: https://github.com/astronaut/my-project
          icon: external
    +     variant: minimal
  • #2168 e044fee Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: Updates the <StarlightPage /> component sidebar prop to accept an array of SidebarItems like the main Starlight sidebar configuration in astro.config.mjs.

    This change simplifies the definition of sidebar items in the <StarlightPage /> component, allows for shared sidebar configuration between the global sidebar option and <StarlightPage /> component, and also enables the usage of autogenerated sidebar groups with the <StarlightPage /> component.
    If you are using the <StarlightPage /> component with a custom sidebar configuration, you will need to update the sidebar prop to an array of SidebarItem objects.

    For example, the following custom page with a custom sidebar configuration defines a “Resources” group with a “New” badge, a link to the “Showcase” page which is part of the docs content collection, and a link to the Starlight website:

    ---
    // src/pages/custom-page/example.astro
    ---
    
    <StarlightPage
      frontmatter={{ title: 'My custom page' }}
      sidebar={[
        {
          type: 'group',
          label: 'Resources',
          badge: { text: 'New' },
          items: [
            { type: 'link', label: 'Showcase', href: '/showcase/' },
            {
              type: 'link',
              label: 'Starlight',
              href: 'https://starlight.astro.build/',
            },
          ],
        },
      ]}
    >
      <p>This is a custom page with a custom component.</p>
    </StarlightPage>

    This configuration will now need to be updated to the following:

    ---
    // src/pages/custom-page/example.astro
    ---
    
    <StarlightPage
      frontmatter={{ title: 'My custom page' }}
      sidebar={[
        {
          label: 'Resources',
          badge: { text: 'New' },
          items: [
            'showcase',
            { label: 'Starlight', link: 'https://starlight.astro.build/' },
          ],
        },
      ]}
    >
      <p>This is a custom page with a custom component.</p>
    </StarlightPage>

    See the “Sidebar Navigation” guide to learn more about the available options for customizing the sidebar.

Don't miss a new starlight release

NewReleases is sending notifications on new releases.