Merge branch 'main' into hd-file-tree

* main: (21 commits) i18n(ja): Update plugins.mdx (withastro#1550) [ci] format docs: Added Portuguese (pt-PT) language (withastro#1503) [ci] format i18n(fr): Update pages.mdx and plugins.mdx (withastro#1545) i18n(hi): update outdated pages (withastro#1539) i18n(es): Update getting-started.mdx (withastro#1531) [ci] format i18n(es): add "pages" page (withastro#1537) i18n(hi): add `customization.mdx` (withastro#1538) Update Vietnamese UI translations (withastro#1544) [ci] format [ci] release (withastro#1540) Improve DX for `sidebar` prop in `<StarlightPage>` and document it (withastro#1534) i18n(zh-tw): add Traditional Chinese UI translations (withastro#1504) Export `StarlightPageProps` type (withastro#1527) [ci] format Add new starlight-ghostcms to Community plugins list (withastro#1536) docs: Add more plugins & tools (withastro#1528) [ci] format ...
HiDeoo · Feb 23, 2024 · 23f6727 · 23f6727
2 parents 1e4d5f9 + 7f727a9
commit 23f6727
Show file tree

Hide file tree

Showing 36 changed files with 1,673 additions and 187 deletions.
diff --git a/.changeset/spotty-hairs-care.md b/.changeset/spotty-hairs-care.md
@@ -0,0 +1,5 @@
+---
+"@astrojs/starlight": patch
+---
+
+Update Vietnamese UI translations
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -11,6 +11,7 @@ i18n:
   - docs/src/content/docs/ja/**/*
   - docs/src/content/docs/zh-cn/**/*
   - docs/src/content/docs/pt-br/**/*
+  - docs/src/content/docs/pt-pt/**/*
   - docs/src/content/docs/ko/**/*
   - docs/src/content/docs/ru/**/*
   - docs/src/content/docs/id/**/*

diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -12,6 +12,7 @@ export const locales = {
 	id: { label: 'Bahasa Indonesia', lang: 'id' },
 	'zh-cn': { label: '简体中文', lang: 'zh-CN' },
 	'pt-br': { label: 'Português do Brasil', lang: 'pt-BR' },
+	'pt-pt': { label: 'Português', lang: 'pt-PT' },
 	ko: { label: '한국어', lang: 'ko' },
 	tr: { label: 'Türkçe', lang: 'tr' },
 	ru: { label: 'Русский', lang: 'ru' },

diff --git a/docs/lunaria.config.json b/docs/lunaria.config.json
@@ -49,6 +49,10 @@
       "label": "Português do Brasil",
       "lang": "pt-br"
     },
+    {
+      "label": "Português",
+      "lang": "pt-pt"
+    },
     {
       "label": "Русский",
       "lang": "ru"

diff --git a/docs/package.json b/docs/package.json
@@ -5,7 +5,7 @@
   "version": "0.0.1",
   "scripts": {
     "test": "start-server-and-test 'pnpm preview' http://localhost:4321 'pnpm pa11y'",
-    "pa11y": "pa11y-ci --sitemap 'http://localhost:4321/sitemap-0.xml' --sitemap-find 'https://starlight.astro.build' --sitemap-replace 'http://localhost:4321' --sitemap-exclude '/(de|zh-cn|fr|es|pt-br|it|id|ko|ru|tr|hi|da|uk)/.*'",
+    "pa11y": "pa11y-ci --sitemap 'http://localhost:4321/sitemap-0.xml' --sitemap-find 'https://starlight.astro.build' --sitemap-replace 'http://localhost:4321' --sitemap-exclude '/(de|zh-cn|fr|es|pt-br|pt-pt|it|id|ko|ru|tr|hi|da|uk)/.*'",
     "dev": "astro dev",
     "start": "astro dev",
     "build": "astro build",

diff --git a/docs/src/content/docs/es/getting-started.mdx b/docs/src/content/docs/es/getting-started.mdx
@@ -83,42 +83,9 @@ Abre esta URL para comenzar a navegar por tu sitio.
 
 Starlight está listo para que añadas nuevo contenido o ¡traigas tus archivos existentes!.
 
-#### Formatos de archivo
+Agrega nuevas páginas a tu sitio web creando archivos Markdown en el directorio `src/content/docs/`.
 
-Starlight admite la creación de contenido en Markdown y MDX sin necesidad de configuración. Puedes agregar compatibilidad con Markdoc instalando la [integración experimental de Astro Markdoc](https://docs.astro.build/es/guides/integrations-guide/markdoc/).
-
-#### Añade páginas
-
-Añade nuevas páginas a tu sitio creando archivos `.md` o `.mdx` en `src/content/docs/`.
-Utiliza subcarpetas para organizar tus archivos y crear múltiples segmentos de ruta.
-
-Por ejemplo, la siguiente estructura de archivos generará páginas en `example.com/hello-world` y `example.com/guides/faq`:
-
-import FileTree from '~/components/file-tree.astro';
-
-<FileTree>
-
-- src/
-  - content/
-    - docs/
-      - guides/
-        - faq.md
-      - hello-world.md
-
-</FileTree>
-
-#### Frontmatter con seguridad de tipos
-
-Todas las páginas de Starlight comparten un [conjunto común personalizable de propiedades frontmatter](/es/reference/frontmatter/) para controlar cómo se muestra la página:
-
-```md
----
-title: ¡Hola, Mundo!
-description: Esta es una página en mi sitio impulsado por Starlight
----
-```
-
-Si olvidas algo importante, Starlight te lo hará saber.
+Lee más sobre el enrutamiento basado en archivos y el soporte para archivos MDX y Markdoc en la [Guía de Páginas](/es/guides/pages/)
 
 ### Siguientes pasos
 

diff --git a/docs/src/content/docs/es/guides/pages.mdx b/docs/src/content/docs/es/guides/pages.mdx
@@ -0,0 +1,173 @@
+---
+title: Páginas
+description: Aprende cómo crear y gestionar las páginas de tu sitio de documentación con Starlight.
+sidebar:
+  order: 1
+---
+
+Starlight genera las páginas HTML de tu sitio basadas en tu contenido, con opciones flexibles proporcionadas a través del frontmatter de Markdown.
+Además, los proyectos de Starlight tienen acceso completo a las [herramientas de generación de páginas de Astro](https://docs.astro.build/es/basics/astro-pages/).
+Esta guía muestra cómo funciona la generación de páginas en Starlight.
+
+## Páginas de contenido
+
+### Formatos de archivo
+
+Starlight admite la creación de contenido en Markdown y MDX sin necesidad de configuración.
+Puedes agregar soporte para Markdoc instalando la integración experimental de [Astro Markdoc](https://docs.astro.build/es/guides/integrations-guide/markdoc/).
+
+### Agregar páginas
+
+Añade nuevas páginas a tu sitio creando archivos `.md` o `.mdx` en `src/content/docs/`.
+Utiliza subcarpetas para organizar tus archivos y crear múltiples segmentos de ruta.
+
+Por ejemplo, la siguiente estructura de archivos generará páginas en `example.com/hello-world` y `example.com/reference/faq`:
+
+import FileTree from '~/components/file-tree.astro';
+
+<FileTree>
+
+- src/
+  - content/
+    - docs/
+      - hello-world.md
+      - reference/
+        - faq.md
+
+</FileTree>
+
+### Frontmatter tipado
+
+Todas las páginas de Starlight comparten un [conjunto común de propiedades de frontmatter personalizables](/es/reference/frontmatter/) para controlar cómo aparece la página:
+
+```md
+---
+title: ¡Hola, mundo!
+description: Esta es una página en mi sitio impulsado por Starlight
+---
+```
+
+Si olvidas algo importante, Starlight te lo hará saber.
+
+## Páginas personalizadas
+
+Para casos de uso avanzados, puedes agregar páginas personalizadas creando un directorio `src/pages/`.
+El directorio `src/pages/` utiliza [enrutamiento basado en archivos de Astro](https://docs.astro.build/es/basics/astro-pages/#enrutamiento-basado-en-archivos) e incluye soporte para archivos `.astro` entre otros formatos de página.
+Esto es útil si necesitas construir páginas con un diseño completamente personalizado o generar una página desde una fuente de datos alternativa.
+
+Por ejemplo, este proyecto mezcla contenido Markdown en `src/content/docs/` con rutas de Astro y HTML en `src/pages/`:
+
+<FileTree>
+
+- src/
+  - content/
+    - docs/
+      - hello-world.md
+  - pages/
+    - custom.astro
+    - archived.html
+
+</FileTree>
+
+Lee más en la [Guía de Páginas en la documentación de Astro](https://docs.astro.build/es/basics/astro-pages/).
+
+### Usar el diseño de Starlight en páginas personalizadas
+
+Para usar el diseño de Starlight en páginas personalizadas, envuelve el contenido de tu página con el componente `<StarlightPage />`.
+Esto puede ser útil si estás generando contenido dinámicamente pero aún quieres usar el diseño de Starlight.
+
+```astro
+---
+// src/pages/custom-page/example.astro
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import CustomComponent from './CustomComponent.astro';
+---
+
+<StarlightPage frontmatter={{ title: 'Mi página personalizada' }}>
+	<p>Esta es una página personalizada con un componente personalizado:</p>
+	<CustomComponent />
+</StarlightPage>
+```
+
+#### Props
+
+El componente `<StarlightPage />` acepta las siguientes props.
+
+##### `frontmatter` (requerido)
+
+**tipo:** `StarlightPageFrontmatter`
+
+Establece las [propiedades de frontmatter](/es/reference/frontmatter/) para esta página, similar al frontmatter en las páginas de Markdown.
+La propiedad [`title`](/es/reference/frontmatter/#title-requerido) es requerida y todas las demás propiedades son opcionales.
+
+Las siguientes propiedades difieren del frontmatter de Markdown:
+
+- La propiedad [`slug`](/es/reference/frontmatter/#slug) no es compatible y se establece automáticamente en función de la URL de la página personalizada.
+- La opción [`editUrl`](/es/reference/frontmatter/#editurl) requiere una URL para mostrar un enlace de edición.
+- La propiedad frontmatter [`sidebar`](/es/reference/frontmatter/#sidebar) para personalizar cómo aparece la página en [grupos de enlaces autogenerados](/es/reference/configuration/#sidebar) no está disponible. Las páginas que utilizan el componente `<StarlightPage />` no forman parte de una colección y no pueden ser agregadas a un grupo de barra lateral autogenerado.
+
+##### `sidebar`
+
+**tipo:** `SidebarEntry[]`  
+**por defecto:** la barra lateral generada basada en la [configuración global de `sidebar`](/es/reference/configuration/#sidebar)
+
+Proporciona una barra lateral de navegación personalizada para esta página.
+Si no se establece, la página usará la barra lateral global predeterminada.
+
+Por ejemplo, la siguiente página sobrescribe la barra lateral predeterminada con un enlace a la página de inicio y un grupo de enlaces a diferentes constelaciones.
+La página actual en la barra lateral se establece utilizando la propiedad `isCurrent` y se ha agregado un `badge` opcional a un elemento de enlace.
+
+```astro {3-13}
+<StarlightPage
+	frontmatter={{ title: 'Orion' }}
+	sidebar={[
+		{ label: 'Home', href: '/' },
+		{
+			label: 'Constelaciones',
+			items: [
+				{ label: 'Andromeda', href: '/andromeda/' },
+				{ label: 'Orion', href: '/orion/', isCurrent: true },
+				{ label: 'Osa Menor', href: '/ursa-minor/', badge: 'Stub' },
+			],
+		},
+	]}
+>
+	Contenido de la página
+</StarlightPage>
+```
+
+##### `hasSidebar`
+
+**tipo:** `boolean`  
+**por defecto:** `false` si [`frontmatter.template`](/es/reference/frontmatter/#template) es `'splash'`, de lo contrario `true`
+
+Controla si la barra lateral debe mostrarse en esta página o no.
+
+##### `headings`
+
+**tipo:** `{ depth: number; slug: string; text: string }[]`  
+**por defecto:** `[]`
+
+Proporciona un array de todos los encabezados en esta página.
+Starlight generará la tabla de contenidos de la página a partir de estos encabezados si se proporcionan.
+
+##### `dir`
+
+**tipo:** `'ltr' | 'rtl'`  
+**por defecto:** la dirección de escritura para la configuración regional actual
+
+Establece la dirección de escritura para el contenido de esta página.
+
+##### `lang`
+
+**tipo:** `string`  
+**por defecto:** el idioma de la configuración regional actual
+
+Establece la etiqueta de idioma BCP-47 para el contenido de esta página, por ejemplo, `en`, `zh-CN` o `pt-BR`.
+
+##### `isFallback`
+
+**tipo:** `boolean`  
+**por defecto:** `false`
+
+Indica si esta página está utilizando [contenido alternativo](/es/guides/i18n/#contenido-de-respaldo) porque no hay traducción para el idioma actual.
diff --git a/docs/src/content/docs/fr/guides/pages.mdx b/docs/src/content/docs/fr/guides/pages.mdx
@@ -104,15 +104,41 @@ Les propriétés suivantes diffèrent du frontmatter en Markdown :
 
 - La propriété [`slug`](/fr/reference/frontmatter/#slug) n'est pas supportée et est automatiquement définie en fonction de l'URL de la page personnalisée.
 - L'option [`editUrl`](/fr/reference/frontmatter/#editurl) nécessite une URL pour afficher un lien d'édition.
-- La propriété [`sidebar`](/fr/reference/frontmatter/#sidebar) n'est pas supportée. Dans le frontmatter en Markdown, cette option permet de personnaliser les [groupes de liens autogénérés](/fr/reference/configuration/#sidebar), ce qui n'est pas applicable aux pages utilisant le composant `<StarlightPage />`.
-
-{/* ##### `sidebar` */}
-
-{/* **Type :** `SidebarEntry[] | undefined` */}
-{/* **Par défaut :** la barre latérale générée en fonction de la [configuration globale `sidebar`](/fr/reference/configuration/#sidebar) */}
-
-{/* Fournir une barre latérale de navigation personnalisée pour cette page. */}
-{/* Si elle n'est pas définie, la page utilisera la barre latérale globale par défaut. */}
+- La propriété [`sidebar`](/fr/reference/frontmatter/#sidebar) du frontmatter permettant de personnaliser l'affichage de la page dans les [groupes de liens autogénérés](/fr/reference/configuration/#sidebar) n'est pas disponible. Les pages utilisant le composant `<StarlightPage />` ne font pas partie d'une collection et ne peuvent pas être ajoutées à un groupe de liens autogénérés.
+
+##### `sidebar`
+
+**Type :** `SidebarEntry[]`  
+**Par défaut :** la barre latérale générée en fonction de la [configuration globale `sidebar`](/fr/reference/configuration/#sidebar)
+
+Fournit une barre latérale de navigation personnalisée pour cette page.
+Si elle n'est pas définie, la page utilisera la barre latérale globale par défaut.
+
+Par exemple, la page suivante remplace la barre latérale par défaut par un lien vers la page d'accueil et un groupe de liens vers différentes constellations.
+La page courante dans la barre latérale est définie à l'aide de la propriété `isCurrent` et un `badge` optionnel a été ajouté à un élément de lien.
+
+```astro {3-13}
+<StarlightPage
+	frontmatter={{ title: 'Orion' }}
+	sidebar={[
+		{ label: 'Accueil', href: '/' },
+		{
+			label: 'Constellations',
+			items: [
+				{ label: 'Andromède', href: '/andromède/' },
+				{ label: 'Orion', href: '/orion/', isCurrent: true },
+				{
+					label: 'La Petite Ourse',
+					href: '/la-petite-ourse/',
+					badge: 'Ébauche',
+				},
+			],
+		},
+	]}
+>
+	Exemple de contenu.
+</StarlightPage>
+```
 
 ##### `hasSidebar`
 

diff --git a/docs/src/content/docs/fr/resources/plugins.mdx b/docs/src/content/docs/fr/resources/plugins.mdx
@@ -6,7 +6,7 @@ sidebar:
 ---
 
 :::tip[Ajoutez le vôtre !]
-Avez-vous construit un modules d'extension ou un outil pour Starlight ?
+Avez-vous construit un module d'extension ou un outil pour Starlight ?
 Ouvrez une PR ajoutant un lien à cette page !
 :::
 
@@ -38,6 +38,26 @@ Les [modules d'extension](/fr/reference/plugins/) peuvent personnaliser la confi
 		title="starlight-typedoc"
 		description="Générer des pages Starlight à partir de TypeScript en utilisant TypeDoc."
 	/>
+	<LinkCard
+		href="https://github.com/HiDeoo/starlight-blog"
+		title="starlight-blog"
+		description="Ajouter un blogue à votre site de documentation."
+	/>
+	<LinkCard
+		href="https://github.com/HiDeoo/starlight-openapi"
+		title="starlight-openapi"
+		description="Créer des pages de documentation à partir de spécifications OpenAPI/Swagger."
+	/>
+	<LinkCard
+		href="https://github.com/HiDeoo/starlight-obsidian"
+		title="starlight-obsidian"
+		description="Publier vos coffres (vaults) Obsidian sur votre site Starlight."
+	/>
+	<LinkCard
+		href="https://astro-ghostcms.xyz/intro/starlight/install/"
+		title="starlight-ghostcms"
+		description="Ajoutez vos articles de blogue GhostCMS à votre documentation Starlight"
+	/>
 </CardGrid>
 
 ## Outils et intégrations communautaires
@@ -52,16 +72,6 @@ Ces outils et intégrations communautaires peuvent être utilisés pour ajouter
 		title="FeelBack"
 		description="Ajouter un système de retour d'expérience utilisateur à vos pages de documentation."
 	/>
-	<LinkCard
-		href="https://github.com/HiDeoo/starlight-blog"
-		title="starlight-blog"
-		description="Ajouter un blogue à votre site de documentation."
-	/>
-	<LinkCard
-		href="https://github.com/HiDeoo/starlight-openapi"
-		title="starlight-openapi"
-		description="Créer des pages de documentation à partir de spécifications OpenAPI/Swagger."
-	/>
 	<LinkCard
 		href="https://github.com/val-town/notion-to-astro"
 		title="notion-to-astro"
@@ -72,4 +82,9 @@ Ces outils et intégrations communautaires peuvent être utilisés pour ajouter
 		title="astro-live-code"
 		description="Afficher vos blocs de code MDX sous forme de composants interactifs"
 	/>
+	<LinkCard
+		href="https://github.com/HiDeoo/starlight-i18n"
+		title="starlight-i18n"
+		description="Extension Visual Studio Code pour aider à traduire les pages Starlight."
+	/>
 </CardGrid>