Skip to content

Commit

Permalink
Merge branch 'main' into hd-feat-tabs-sync
Browse files Browse the repository at this point in the history
  • Loading branch information
delucis authored Apr 12, 2024
2 parents a878d76 + 124d547 commit 338f9b8
Show file tree
Hide file tree
Showing 132 changed files with 4,652 additions and 914 deletions.
5 changes: 5 additions & 0 deletions .changeset/sweet-vans-carry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/starlight': patch
---

Refactors `<ThemeSelect>` custom element logic to improve performance
5 changes: 5 additions & 0 deletions .changeset/swift-files-wave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/starlight': patch
---

Fixes responding to system color scheme changes when theme is `auto`
45 changes: 45 additions & 0 deletions .github/workflows/file-icons.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: File icons generator

on:
schedule:
- cron: '0 0 * * 0'
workflow_dispatch:

permissions:
contents: write
pull-requests: write

jobs:
icons:
name: Generate file icons
if: github.repository_owner == 'withastro'
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v4

- name: Setup PNPM
uses: pnpm/action-setup@v3

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 18
cache: 'pnpm'

- name: Install Dependencies
run: pnpm i

- name: Run file icons generator
run: pnpm build
working-directory: packages/file-icons-generator

- name: Create Pull Request
uses: peter-evans/create-pull-request@v6
with:
branch: ci/file-icons
token: ${{ secrets.FREDKBOT_GITHUB_TOKEN }}
commit-message: 'ci: update file icons'
title: 'ci: update file icons'
body: |
This PR is auto-generated by a GitHub action to update the file icons and file tree definitions available in Starlight.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,3 +285,28 @@ To add a language, you will need its BCP-47 tag and a label. See [“Adding a ne
[api-docs]: https://docs.astro.build/en/reference/integrations-reference/
[vitest]: https://vitest.dev/
[playwright]: https://playwright.dev/

## Showcase

We love to see websites built with Starlight and share them with the community on our [showcase](https://starlight.astro.build/resources/showcase/) page.
If you’ve built a documentation site with Starlight, adding it to the showcase is just a pull request away!

1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
2. Add a screenshot of your site to the `docs/src/assets/showcase/` directory. The image file must:
- Be a `.png` file and named after your site’s domain, e.g. `example.com.png`.
- Have the dimensions of 800 × 450 pixels.
3. Add a new entry for your website in `docs/src/components/showcase-sites.astro`.

- The new entry must be appended at the end of the existing list of sites.
- The `title` attribute must be the name of your site with no extra details.
- The `href` attribute must be the URL of your Starlight site. If your documentation is hosted on a subdomain or subdirectory, include that in the URL.
- The `thumbnail` attribute must be the filename of the screenshot you added in step 2.

```diff
<Card title="Example" href="https://example.net" thumbnail="example.net.png" />
<Card title="Last Example" href="https://example.org" thumbnail="example.org.png" />
+ <Card title="New Example" href="https://example.com" thumbnail="example.com.png" />
</FluidGrid>
```

4. Open a pull request on GitHub to add your changes.
5 changes: 4 additions & 1 deletion docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export default defineConfig({
'pt-PT': 'Comece Aqui',
ko: '여기서부터',
tr: 'Buradan Başlayın',
ru: 'Начать отсюда',
ru: 'Первые шаги',
hi: 'यहाँ से शुरू करे',
uk: 'Почніть звідси',
},
Expand Down Expand Up @@ -160,6 +160,7 @@ export default defineConfig({
id: 'Panduan',
'zh-CN': '指南',
'pt-BR': 'Guias',
'pt-PT': 'Guias',
ko: '가이드',
tr: 'Rehber',
ru: 'Руководства',
Expand Down Expand Up @@ -194,7 +195,9 @@ export default defineConfig({
'zh-CN': '资源',
fr: 'Ressources',
'pt-BR': 'Recursos',
'pt-PT': 'Recursos',
ja: 'リソース',
ru: 'Ресурсы',
},
autogenerate: { directory: 'resources' },
},
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
},
"devDependencies": {
"pa11y-ci": "^3.0.1",
"starlight-links-validator": "^0.5.3",
"starlight-links-validator": "^0.7.1",
"start-server-and-test": "^2.0.0"
}
}
Binary file added docs/src/assets/showcase/docs.fontawesome.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/ion.sst.dev.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/sudovanilla.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/src/components/showcase-sites.astro
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,15 @@ import FluidGrid from './fluid-grid.astro';
/>
<Card title="DipSway" href="https://api.dipsway.com" thumbnail="api.dipsway.com.png" />
<Card title="RunsOn" href="https://runs-on.com" thumbnail="runs-on.com.png" />
<Card
title="SudoVanilla"
href="https://sudovanilla.com/docs/minpluto/"
thumbnail="sudovanilla.com.png"
/>
<Card title="SST Ion" href="https://ion.sst.dev/" thumbnail="ion.sst.dev.png" />
<Card
title="Font Awesome"
href="https://docs.fontawesome.com/"
thumbnail="docs.fontawesome.com.png"
/>
</FluidGrid>
4 changes: 2 additions & 2 deletions docs/src/content/docs/de/guides/authoring-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Deine Benutzer können dank hilfreicher Starlight-Funktionen produktiver sein un

- Übersichtliche Navigation
- Benutzer-konfigurierbares Farbthema
- [i18n-Unterstützung](/de/guides/i18n)
- [i18n-Unterstützung](/de/guides/i18n/)

:::

Expand All @@ -161,7 +161,7 @@ Deine Benutzer können dank hilfreicher Starlight-Funktionen produktiver sein un

- Übersichtliche Navigation
- Benutzer-konfigurierbares Farbthema
- [i18n-Unterstützung](/de/guides/i18n)
- [i18n-Unterstützung](/de/guides/i18n/)

:::
```
Expand Down
10 changes: 5 additions & 5 deletions docs/src/content/docs/de/reference/overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ tableOfContents:
maxHeadingLevel: 4
---

Du kannst Starlight's eingebaute Komponenten überschreiben, indem du Pfade zu Ersatzkomponenten in Starlight's [`components`](/de/reference/configuration#components)-Konfigurationsoption angibst.
Du kannst Starlight's eingebaute Komponenten überschreiben, indem du Pfade zu Ersatzkomponenten in Starlight's [`components`](/de/reference/configuration/#components)-Konfigurationsoption angibst.
Diese Seite listet alle Komponenten auf, die überschrieben werden können, und verweist auf ihre Standardimplementierungen auf GitHub.

Erfahre mehr in der [Anleitung zum Überschreiben von Komponenten](/de/guides/overriding-components/).
Expand Down Expand Up @@ -151,7 +151,7 @@ Diese Komponente wird innerhalb des `<head>` einer jeden Seite gerendert.
Enthält wichtige Tags wie `<title>`, und `<meta charset="utf-8">`.

Überschreibe diese Komponente nur, wenn es unbedingt notwendig ist.
Bevorzuge die [`head`](/de/reference/configuration#head) Option der Starlight-Konfiguration wenn möglich.
Bevorzuge die [`head`](/de/reference/configuration/#head) Option der Starlight-Konfiguration wenn möglich.

#### `ThemeProvider`

Expand Down Expand Up @@ -232,7 +232,7 @@ Die Standardimplementierung enthält die Schaltfläche in der Kopfzeile und den
**Standardkomponente:** [`SocialIcons.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/SocialIcons.astro)

Diese Komponente wird in der Kopfzeile der Website gerendert und enthält Links zu sozialen Symbolen.
Die Standardimplementierung verwendet die Option [`social`](/de/reference/configuration#social) in der Starlight-Konfiguration, um Icons und Links darzustellen.
Die Standardimplementierung verwendet die Option [`social`](/de/reference/configuration/#social) in der Starlight-Konfiguration, um Icons und Links darzustellen.

#### `ThemeSelect`

Expand Down Expand Up @@ -305,7 +305,7 @@ Folgende Komponenten werden in der Hauptspalte des Seiteninhalts wiedergegeben.
**Standardkomponente:** [`Banner.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Banner.astro)

Diese Bannerkomponente wird oben auf jeder Seite angezeigt.
Die Standard-Implementierung verwendet den [`banner`](/de/reference/frontmatter#banner)-Frontmatter-Wert der Seite, um zu entscheiden, ob sie gerendert wird oder nicht.
Die Standard-Implementierung verwendet den [`banner`](/de/reference/frontmatter/#banner)-Frontmatter-Wert der Seite, um zu entscheiden, ob sie gerendert wird oder nicht.

#### `ContentPanel`

Expand All @@ -332,7 +332,7 @@ Wird nur auf mehrsprachigen Seiten verwendet.

**Standardkomponente:** [`Hero.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Hero.astro)

Diese Komponente wird am oberen Rand der Seite angezeigt, wenn [`hero`](/de/reference/frontmatter#hero) in frontmatter eingestellt ist.
Diese Komponente wird am oberen Rand der Seite angezeigt, wenn [`hero`](/de/reference/frontmatter/#hero) in frontmatter eingestellt ist.
Die Standardimplementierung zeigt einen großen Titel, eine Tagline und Call-to-Action-Links neben einem optionalen Bild.

#### `MarkdownContent`
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/es/guides/authoring-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Tus usuarios pueden ser más productivos y encontrar más fácil de usar tu prod

- Navegación clara
- Tema de color configurable por el usuario
- [Soporte de i18n](/es/guides/i18n)
- [Soporte de i18n](/es/guides/i18n/)

:::

Expand All @@ -178,7 +178,7 @@ Tus usuarios pueden ser más productivos y encontrar más fácil de usar tu prod

- Navegación clara
- Tema de color configurable por el usuario
- [Soporte de i18n](/es/guides/i18n)
- [Soporte de i18n](/es/guides/i18n/)

:::
```
Expand Down
24 changes: 12 additions & 12 deletions docs/src/content/docs/es/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -489,18 +489,18 @@ Si necesitas establecer variantes adicionales o favicons de respaldo, puedes agr

```js
starlight({
favicon: '/images/favicon.svg'.
head: [
// Agregar un favicon ICO de respaldo para Safari.
{
tag: 'link',
attrs: {
rel: 'icon',
href:'/images/favicon.ico',
sizes: '32x32',
},
},
],
favicon: '/images/favicon.svg',
head: [
// Agregar un favicon ICO de respaldo para Safari.
{
tag: 'link',
attrs: {
rel: 'icon',
href: '/images/favicon.ico',
sizes: '32x32',
},
},
],
});
```

Expand Down
10 changes: 5 additions & 5 deletions docs/src/content/docs/es/reference/overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ tableOfContents:
maxHeadingLevel: 4
---

Puedes reemplazar los componentes integrados de Starlight proporcionando rutas a los componentes en la opción de configuración [`components`](/es/reference/configuration#components) de Starlight.
Puedes reemplazar los componentes integrados de Starlight proporcionando rutas a los componentes en la opción de configuración [`components`](/es/reference/configuration/#components) de Starlight.

Esta página enumera todos los componentes disponibles para reemplazar y enlaces a sus implementaciones predeterminadas en GitHub.

Expand Down Expand Up @@ -159,7 +159,7 @@ Componente renderizado dentro del elemento `<head>` de cada página.
Incluye etiquetas importantes como `<title>` y `<meta charset="utf-8">`.

Reemplaza este componente como último recurso.
Si es posible, prefiere la opción [`head`](/es/reference/configuration#head) de la configuración de Starlight si es posible.
Si es posible, prefiere la opción [`head`](/es/reference/configuration/#head) de la configuración de Starlight si es posible.

#### `ThemeProvider`

Expand Down Expand Up @@ -242,7 +242,7 @@ Cuando [`pagefind`](/es/reference/configuration/#pagefind) está deshabilitado,
**Componente por defecto:** [`SocialIcons.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/SocialIcons.astro)

Componente renderizado en el encabezado del sitio que incluye enlaces de iconos sociales.
La implementación predeterminada utiliza la opción [`social`](/es/reference/configuration#social) en la configuración de Starlight para renderizar iconos y enlaces.
La implementación predeterminada utiliza la opción [`social`](/es/reference/configuration/#social) en la configuración de Starlight para renderizar iconos y enlaces.

#### `ThemeSelect`

Expand Down Expand Up @@ -315,7 +315,7 @@ Estos componentes se renderizan en la columna principal del contenido de la pág
**Componente por defecto:** [`Banner.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Banner.astro)

Componente Banner renderizado en la parte superior de cada página.
La implementación predeterminada usa el valor de frontmatter [`banner`](/es/reference/frontmatter#banner) de la página para decidir si renderizar o no.
La implementación predeterminada usa el valor de frontmatter [`banner`](/es/reference/frontmatter/#banner) de la página para decidir si renderizar o no.

#### `ContentPanel`

Expand Down Expand Up @@ -343,7 +343,7 @@ Solo se usa en sitios multilingües.

**Componente por defecto:** [`Hero.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Hero.astro)

Componente renderizado en la parte superior de la página cuando [`hero`](/es/reference/frontmatter#hero) está establecido en frontmatter.
Componente renderizado en la parte superior de la página cuando [`hero`](/es/reference/frontmatter/#hero) está establecido en frontmatter.
La implementación predeterminada muestra un título grande, un lema y enlaces de llamada a la acción junto con una imagen opcional.

#### `MarkdownContent`
Expand Down
8 changes: 4 additions & 4 deletions docs/src/content/docs/es/reference/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ Este hook es llamado con las siguientes opciones:

**tipo:** `StarlightUserConfig`

Una copia de lectura de la [configuración de Starlight](/es/reference/configuration) proporcionada por el usuario.
Una copia de lectura de la [configuración de Starlight](/es/reference/configuration/) proporcionada por el usuario.
Esta configuración puede haber sido actualizada por otros plugins configurados antes del actual.

#### `updateConfig`

**tipo:** `(newConfig: StarlightUserConfig) => void`

Una función callback para actualizar la [configuración de Starlight](/es/reference/configuration).
Una función callback para actualizar la [configuración de Starlight](/es/reference/configuration/).
Proporciona las claves de configuración de nivel raíz que deseas sobreescribir.
Para actualizar los valores de configuración anidados, debes proporcionar el objeto anidado completo.

Expand Down Expand Up @@ -100,7 +100,7 @@ import react from '@astrojs/react';
export default {
name: 'plugin-using-react',
hooks: {
plugin({ addIntegration, astroConfig }) {
setup({ addIntegration, astroConfig }) {
const isReactLoaded = astroConfig.integrations.find(
({ name }) => name === '@astrojs/react'
);
Expand Down Expand Up @@ -149,7 +149,7 @@ Todos los mensajes de registro se prefijarán con el nombre del plugin.
export default {
name: 'long-process-plugin',
hooks: {
plugin({ logger }) {
setup({ logger }) {
logger.info('Empezando un proceso largo…');
// Algun proceso largo…
},
Expand Down
5 changes: 5 additions & 0 deletions docs/src/content/docs/es/resources/community-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ Explora contenido producido por la comunidad mantenido por usuarios de Starlight
title="Publicación de documentación con Astro Starlight"
description="Comenzando con la documentación de Starlight."
/>
<LinkCard
href="https://events-3bg.pages.dev/jotter/starlight/guide/"
title="Habilita View Transitions"
description="Consigue esa apariencia SPA con el soporte de View Transitions de Bag of Tricks"
/>

</CardGrid>

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/es/resources/showcase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar:

:::tip[¡Agrega el tuyo!]
¿Has construido un sitio de Starlight o una herramienta para Starlight?
¡Abre una PR agregando un enlace a esta página!
¡[Abre una PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#showcase) agregando un enlace a esta página!
:::

## Sitios
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/fr/guides/authoring-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Vos utilisateurs peuvent être plus productifs et trouver votre produit plus fac

- Navigation claire
- Thème de couleurs configurable par l'utilisateur
- [Support i18n](/fr/guides/i18n)
- [Support i18n](/fr/guides/i18n/)

:::

Expand All @@ -178,7 +178,7 @@ Vos utilisateurs peuvent être plus productifs et trouver votre produit plus fac

- Navigation claire
- Thème de couleurs configurable par l'utilisateur
- [Support i18n](/fr/guides/i18n)
- [Support i18n](/fr/guides/i18n/)

:::
```
Expand Down
Loading

0 comments on commit 338f9b8

Please sign in to comment.