Files
charts/website
TrueCharts Bot 436a258642 fix(website): update @astrojs/starlight 0.29.3 → 0.31.1 (#30902)
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@astrojs/starlight](https://starlight.astro.build)
([source](https://redirect.github.com/withastro/starlight/tree/HEAD/packages/starlight))
| dependencies | minor | [`0.30.6` ->
`0.31.1`](https://renovatebot.com/diffs/npm/@astrojs%2fstarlight/0.29.3/0.31.1)
|

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

Add the preset `:preserveSemverRanges` to your config if you don't want
to pin your dependencies.

---

### Release Notes

<details>
<summary>withastro/starlight (@&#8203;astrojs/starlight)</summary>

###
[`v0.31.1`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0311)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.31.0...@astrojs/starlight@0.31.1)

##### Patch Changes

-
[#&#8203;2805](https://redirect.github.com/withastro/starlight/pull/2805)
[`ed6f9fd`](ed6f9fd773)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Exposes
the
[`StarlightIcon`](https://starlight.astro.build/reference/icons/#starlighticon-type)
TypeScript type referencing the names of Starlight’s built-in icons.

###
[`v0.31.0`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0310)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.30.6...@astrojs/starlight@0.31.0)

##### Minor Changes

-
[#&#8203;2777](https://redirect.github.com/withastro/starlight/pull/2777)
[`88f4214`](88f4214588)
Thanks [@&#8203;hippotastic](https://redirect.github.com/hippotastic)! -
Updates `astro-expressive-code` dependency to the latest version (0.40).

This includes an update to the latest Shiki version (1.26.1), providing
access to all current Shiki themes and syntax highlighting languages,
and adding the config options `shiki.engine`, `shiki.bundledLangs`,
`shiki.langAlias` and `removeUnusedThemes`. It also adds new style
variants to the optional collapsible sections plugin.

See the [Expressive Code release
notes](https://expressive-code.com/releases/#&#8203;0400) for full
details.

-
[#&#8203;2736](https://redirect.github.com/withastro/starlight/pull/2736)
[`29a885b`](29a885be43)
Thanks [@&#8203;delucis](https://redirect.github.com/delucis)! - ⚠️
**BREAKING CHANGE:** The minimum supported version of Astro is now 5.1.5

    Please update Astro and Starlight together:

    ```sh
    npx @&#8203;astrojs/upgrade
    ```

-
[#&#8203;2728](https://redirect.github.com/withastro/starlight/pull/2728)
[`e187383`](e1873834d4)
Thanks [@&#8203;delucis](https://redirect.github.com/delucis)! - Updates
minimum Pagefind dependency to v1.3.0, sets new defaults for Pagefind’s
ranking options, and adds support for manually configuring the ranking
options

The new ranking option defaults have been evaluated against Starlight’s
own docs to improve the quality of search results. See [“Customize
Pagefind's result ranking”](https://pagefind.app/docs/ranking/) for more
details about how they work.

-
[#&#8203;157](https://redirect.github.com/withastro/starlight/pull/157)
[`23bf960`](23bf960aed)
Thanks [@&#8203;tony-sull](https://redirect.github.com/tony-sull)! -
Adds a print stylesheet to improve the appearance of Starlight docs
pages when printed

-
[#&#8203;2728](https://redirect.github.com/withastro/starlight/pull/2728)
[`e187383`](e1873834d4)
Thanks [@&#8203;delucis](https://redirect.github.com/delucis)! - Fixes
Pagefind logging to respect the Astro log level. When using Astro’s
`--verbose` or `--silent` CLI flags, these are now respected by Pagefind
as well.

##### Patch Changes

-
[#&#8203;2792](https://redirect.github.com/withastro/starlight/pull/2792)
[`412effb`](412effb5a6)
Thanks [@&#8203;dhruvkb](https://redirect.github.com/dhruvkb)! - Uses
semantic `var(--sl-color-hairline)` for the page sidebar border instead
of `var(--sl-color-gray-6)`. This is visually the same as previously but
makes it easier to override the hairline color consistently across a
site.

-
[#&#8203;2736](https://redirect.github.com/withastro/starlight/pull/2736)
[`29a885b`](29a885be43)
Thanks [@&#8203;delucis](https://redirect.github.com/delucis)! - Updates
internal dependencies `@astrojs/sitemap` and `@astrojs/mdx` to the
latest versions

-
[#&#8203;2782](https://redirect.github.com/withastro/starlight/pull/2782)
[`d9d415b`](d9d415b455)
Thanks [@&#8203;delucis](https://redirect.github.com/delucis)! - Fixes a
documentation link in the JSDoc comment for the
`StarlightExpressiveCodeOptions` type

-
[#&#8203;2708](https://redirect.github.com/withastro/starlight/pull/2708)
[`442c819`](442c8194db)
Thanks [@&#8203;delucis](https://redirect.github.com/delucis)! - Fixes
colour contrast correction in code blocks

###
[`v0.30.6`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0306)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.30.5...@astrojs/starlight@0.30.6)

##### Patch Changes

-
[#&#8203;2722](https://redirect.github.com/withastro/starlight/pull/2722)
[`0b206d3`](0b206d3a23)
Thanks [@&#8203;techfg](https://redirect.github.com/techfg)! - Fixes
display of long site title on mobile

-
[#&#8203;2762](https://redirect.github.com/withastro/starlight/pull/2762)
[`7ab1576`](7ab157639d)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Prevents
the header title from being translated by automatic translation systems.

###
[`v0.30.5`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0305)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.30.4...@astrojs/starlight@0.30.5)

##### Patch Changes

-
[#&#8203;2757](https://redirect.github.com/withastro/starlight/pull/2757)
[`e7b0e74`](e7b0e742df)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Fixes a
UI string translation issue for languages with a region subtag.

-
[#&#8203;2760](https://redirect.github.com/withastro/starlight/pull/2760)
[`aec9edd`](aec9edd148)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Adds 5
new icons: `left-caret`, `up-arrow`, `down-arrow`, `download`, and
`cloud-download`.

###
[`v0.30.4`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0304)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.30.3...@astrojs/starlight@0.30.4)

##### Patch Changes

-
[#&#8203;2747](https://redirect.github.com/withastro/starlight/pull/2747)
[`474c27e`](474c27e28d)
Thanks [@&#8203;bbag](https://redirect.github.com/bbag)! - Ensures
`<Tab>` component toggling is stable when smooth scrolling is enabled
via custom CSS

-
[#&#8203;2740](https://redirect.github.com/withastro/starlight/pull/2740)
[`0e169c9`](0e169c9fd9)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Fixes an
issue preventing Pagefind to be disabled using the `pagefind`
frontmatter field.

-
[#&#8203;2732](https://redirect.github.com/withastro/starlight/pull/2732)
[`a10b466`](a10b466808)
Thanks [@&#8203;Sidnioulz](https://redirect.github.com/Sidnioulz)! -
Adds Storybook, Confluence and Jira social icons

###
[`v0.30.3`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0303)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.30.2...@astrojs/starlight@0.30.3)

##### Patch Changes

-
[#&#8203;2717](https://redirect.github.com/withastro/starlight/pull/2717)
[`c5fcbb3`](c5fcbb33a7)
Thanks [@&#8203;delucis](https://redirect.github.com/delucis)! - Fixes a
list item spacing issue where line break elements (`<br>`) could receive
a margin, breaking layout in Firefox

-
[#&#8203;2724](https://redirect.github.com/withastro/starlight/pull/2724)
[`02d7ac6`](02d7ac66a0)
Thanks [@&#8203;dionysuzx](https://redirect.github.com/dionysuzx)! -
Adds social link support for Farcaster

-
[#&#8203;2635](https://redirect.github.com/withastro/starlight/pull/2635)
[`ec4b851`](ec4b85154e)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Fixes an
issue where the language picker in multilingual sites could display the
wrong language when navigating between pages with the browser
back/forward buttons.

-
[#&#8203;2726](https://redirect.github.com/withastro/starlight/pull/2726)
[`e54ebd5`](e54ebd5c87)
Thanks [@&#8203;techfg](https://redirect.github.com/techfg)! - Adds icon
for phone

###
[`v0.30.2`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0302)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.30.1...@astrojs/starlight@0.30.2)

##### Patch Changes

-
[#&#8203;2702](https://redirect.github.com/withastro/starlight/pull/2702)
[`02d16f3`](02d16f3638)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Fixes an
issue with autogenerated sidebars when using Starlight with Astro's new
Content Layer API with directories containing spaces or special
characters.

-
[#&#8203;2704](https://redirect.github.com/withastro/starlight/pull/2704)
[`fd16470`](fd164704b2)
Thanks [@&#8203;delucis](https://redirect.github.com/delucis)! - Fixes
display of focus indicator around site title

###
[`v0.30.1`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0301)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.30.0...@astrojs/starlight@0.30.1)

##### Patch Changes

-
[#&#8203;2688](https://redirect.github.com/withastro/starlight/pull/2688)
[`5c6996c`](5c6996cd24)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Fixes an
issue with autogenerated sidebars when using Starlight with Astro's new
Content Layer API where group names would be sluggified.

###
[`v0.30.0`](https://redirect.github.com/withastro/starlight/blob/HEAD/packages/starlight/CHANGELOG.md#0300)

[Compare
Source](https://redirect.github.com/withastro/starlight/compare/@astrojs/starlight@0.29.3...@astrojs/starlight@0.30.0)

##### Minor Changes

-
[#&#8203;2612](https://redirect.github.com/withastro/starlight/pull/2612)
[`8d5a4e8`](8d5a4e8000)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Adds
support for Astro v5, drops support for Astro v4.

##### Upgrade Astro and dependencies

⚠️ **BREAKING CHANGE:** Astro v4 is no longer supported. Make sure you
[update Astro](https://docs.astro.build/en/guides/upgrade-to/v5/) and
any other official integrations at the same time as updating Starlight:

```sh
npx @&#8203;astrojs/upgrade
```

*Community Starlight plugins and Astro integrations may also need to be
manually updated to work with Astro v5. If you encounter any issues,
please reach out to the plugin or integration author to see if it is a
known issue or if an updated version is being worked on.*

##### Update your collections

⚠️ **BREAKING CHANGE:** Starlight's internal [content
collections](https://docs.astro.build/en/guides/content-collections/),
which organize, validate, and render your content, have been updated to
use Astro's new Content Layer API and require configuration changes in
your project.

1. **Move the content config file.** This file no longer lives within
the `src/content/config.ts` folder and should now exist at
`src/content.config.ts`.

2. **Edit the collection definition(s).** To update the `docs`
collection, a `loader` is now required:

    ```diff
     // src/content.config.ts
     import { defineCollection } from "astro:content";
    +import { docsLoader } from "@&#8203;astrojs/starlight/loaders";
     import { docsSchema } from "@&#8203;astrojs/starlight/schema";

     export const collections = {
    -  docs: defineCollection({ schema: docsSchema() }),
+ docs: defineCollection({ loader: docsLoader(), schema: docsSchema()
}),
     };
    ```

If you are using the [`i18n`
collection](https://starlight.astro.build/guides/i18n/#translate-starlights-ui)
to provide translations for additional languages you support or override
our default labels, you will need to update the collection definition in
a similar way and remove the collection `type` which is no longer
available:

    ```diff
     // src/content.config.ts
     import { defineCollection } from "astro:content";
+import { docsLoader, i18nLoader } from
"@&#8203;astrojs/starlight/loaders";
import { docsSchema, i18nSchema } from
"@&#8203;astrojs/starlight/schema";

     export const collections = {
    -  docs: defineCollection({ schema: docsSchema() }),
+ docs: defineCollection({ loader: docsLoader(), schema: docsSchema()
}),
    -  i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
+ i18n: defineCollection({ loader: i18nLoader(), schema: i18nSchema()
}),
     };
    ```

3. **Update other collections.** To update any other collections you may
have, follow the [“Updating existing
collections”](https://docs.astro.build/en/guides/upgrade-to/v5/#updating-existing-collections)
section in the Astro 5 upgrade guide.

If you are unable to make any changes to your collections at this time,
including Starlight's default `docs` and `i18n` collections, you can
enable the [`legacy.collections`
flag](https://docs.astro.build/en/reference/legacy-flags/) to upgrade to
v5 without updating your collections. This legacy flag exists to provide
temporary backwards compatibility, and will allow you to keep your
collections in their current state until the legacy flag is no longer
supported.

##### Patch Changes

-
[#&#8203;2669](https://redirect.github.com/withastro/starlight/pull/2669)
[`310df7d`](310df7d6b0)
Thanks
[@&#8203;aaronperezaguilera](https://redirect.github.com/aaronperezaguilera)!
- Adds Catalan UI translations

-
[#&#8203;2664](https://redirect.github.com/withastro/starlight/pull/2664)
[`62ff007`](62ff0074d9)
Thanks [@&#8203;HiDeoo](https://redirect.github.com/HiDeoo)! - Publishes
provenance containing verifiable data to link a package back to its
source repository and the specific build instructions used to publish
it.

-
[#&#8203;2670](https://redirect.github.com/withastro/starlight/pull/2670)
[`0223b42`](0223b42524)
Thanks
[@&#8203;aaronperezaguilera](https://redirect.github.com/aaronperezaguilera)!
- Adds Spanish UI translations for the Pagefind search modal

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://redirect.github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS44Ni4xIiwidXBkYXRlZEluVmVyIjoiMzkuODYuMSIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6WyJhdXRvbWVyZ2UiLCJyZW5vdmF0ZS9jb250YWluZXIiLCJ0eXBlL21pbm9yIl19-->
2025-01-24 15:54:54 +00:00
..
2024-10-19 15:18:05 +02:00
2024-10-19 15:18:05 +02:00

Chart Docs

News

  • To add new authors, add their username in the authors.ts file in src/content/docs/news/authors.ts.
  • News Posts must have these fields in the frontmatter:
    • title
    • slug (must start with news/)
    • date
    • authors (The key in the authors object in src/content/docs/news/authors.ts)

Supported Code Block Languages

Check upstream docs

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run dev-windows Starts local dev server on windows machines
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

👀 Want to learn more?

Check out Starlights docs, read the Astro documentation, or jump into the Astro Discord server.