diff --git a/.changeset/spotty-hairs-care.md b/.changeset/spotty-hairs-care.md new file mode 100644 index 00000000000..3a43124c2d0 --- /dev/null +++ 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 index 369329b07fc..6049ae3c76a 100644 --- 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 index 005921e7da0..40ec5df1459 100644 --- 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' }, @@ -189,6 +190,7 @@ export default defineConfig({ 'zh-CN': '资源', fr: 'Ressources', 'pt-BR': 'Recursos', + ja: 'リソース', }, autogenerate: { directory: 'resources' }, }, diff --git a/docs/lunaria.config.json b/docs/lunaria.config.json index 7051c270e5b..8f8d9ecb479 100644 --- 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 index 8a751b95ef7..b6a13ab26d7 100644 --- 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/assets/showcase/astro-ghostcms.xyz.png b/docs/src/assets/showcase/astro-ghostcms.xyz.png new file mode 100644 index 00000000000..14c96f59033 Binary files /dev/null and b/docs/src/assets/showcase/astro-ghostcms.xyz.png differ diff --git a/docs/src/components/showcase-sites.astro b/docs/src/components/showcase-sites.astro index 1072087c48d..78ab4c9dc28 100644 --- a/docs/src/components/showcase-sites.astro +++ b/docs/src/components/showcase-sites.astro @@ -100,4 +100,9 @@ import FluidGrid from './fluid-grid.astro'; href="https://astro-snipcart.vercel.app/" thumbnail="astro-snipcart.png" /> + diff --git a/docs/src/content/docs/es/getting-started.mdx b/docs/src/content/docs/es/getting-started.mdx index 116c8b45b50..dbe79dd7c89 100644 --- 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'; - - - -- src/ - - content/ - - docs/ - - guides/ - - faq.md - - hello-world.md - - - -#### 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 new file mode 100644 index 00000000000..ad90e1d8627 --- /dev/null +++ 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'; + + + +- src/ + - content/ + - docs/ + - hello-world.md + - reference/ + - faq.md + + + +### 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/`: + + + +- src/ + - content/ + - docs/ + - hello-world.md + - pages/ + - custom.astro + - archived.html + + + +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 ``. +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'; +--- + + +

Esta es una página personalizada con un componente personalizado:

+ + +``` + +#### Props + +El componente `` 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 `` 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} + + Contenido de la página + +``` + +##### `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/es/resources/plugins.mdx b/docs/src/content/docs/es/resources/plugins.mdx index 0efb643c2d1..cf05ace8a26 100644 --- a/docs/src/content/docs/es/resources/plugins.mdx +++ b/docs/src/content/docs/es/resources/plugins.mdx @@ -38,6 +38,26 @@ Amplia tu sitio con un plugins oficiales respaldados por el equipo de Starlight title="starlight-typedoc" description="Genera páginas de Starlight desde TypeScript usando TypeDoc" /> + + + + ## Herramientas e integraciones de la comunidad @@ -52,16 +72,6 @@ Estas herramientas e integraciones de la comunidad se pueden utilizar para añad title="FeelBack" description="Agrega un sistema de comentarios de usuarios a la páginas de tus docs." /> - - + diff --git a/docs/src/content/docs/fr/getting-started.mdx b/docs/src/content/docs/fr/getting-started.mdx index 6db6b5778ef..4c38de663f3 100644 --- a/docs/src/content/docs/fr/getting-started.mdx +++ b/docs/src/content/docs/fr/getting-started.mdx @@ -83,50 +83,16 @@ Ouvrez cette URL pour commencer à naviguer sur votre site. Starlight est prêt pour que vous puissiez ajouter du nouveau contenu, ou apporter vos fichiers existants ! -#### Formats de fichiers +Ajoutez de nouvelles pages à votre site en créant des fichiers Markdown dans le répertoire `src/content/docs/`. -Starlight prend en charge la création de contenu en Markdown et MDX sans aucune configuration requise. -Vous pouvez ajouter la prise en charge de Markdoc en installant [l'intégration Astro Markdoc](https://docs.astro.build/fr/guides/integrations-guide/markdoc/) expérimentale. - -#### Ajouter des pages - -Ajoutez de nouvelles pages à votre site en créant des fichiers `.md` ou `.mdx` dans `src/content/docs/`. -Utilisez des sous-dossiers pour organiser vos fichiers et créer plusieurs segments de chemin. - -Par exemple, la structure de fichiers suivante génére des pages à `example.com/hello-world` et `example.com/guides/faq` : - -import FileTree from '~/components/file-tree.astro'; - - - -- src/ - - content/ - - docs/ - - guides/ - - faq.md - - hello-world.md - - - -#### Frontmatter avec sûreté du typage - -Toutes les pages Starlight partagent un [ensemble commun de propriétés du frontmatter](/fr/reference/frontmatter/) personnalisable pour contrôler l'apparence de la page : - -```md ---- -title: Bonjour, le monde ! -description: Ceci est une page de mon site web propulsé par Starlight. ---- -``` - -Si vous oubliez quelque chose d'important, Starlight vous le fera savoir. +Pour en savoir plus sur le routage par fichier et la prise en charge des fichiers MDX et Markdoc, consultez le guide [« Pages »](/fr/guides/pages/). ### Prochaines étapes -- **Configurer:** Découvrez les options courantes dans [« Personnaliser Starlight »](/fr/guides/customization/). -- **Naviguer:** Configurez votre barre latérale avec le guide [« Barre latérale de navigation »](/fr/guides/sidebar/). -- **Composants:** Découvrez les cartes, les onglets et d'autres composants intégrés dans le guide [« Composants »](/fr/guides/components/). -- **Déployer:** Publiez votre travail avec le guide [« Déployer votre site »](https://docs.astro.build/fr/guides/deploy/) dans la documentation d'Astro. +- **Configurer :** Découvrez les options courantes dans [« Personnaliser Starlight »](/fr/guides/customization/). +- **Naviguer :** Configurez votre barre latérale avec le guide [« Barre latérale de navigation »](/fr/guides/sidebar/). +- **Composants :** Découvrez les cartes, les onglets et d'autres composants intégrés dans le guide [« Composants »](/fr/guides/components/). +- **Déployer :** Publiez votre travail avec le guide [« Déployer votre site »](https://docs.astro.build/fr/guides/deploy/) dans la documentation d'Astro. ## Mettre à jour Starlight @@ -135,8 +101,7 @@ Comme Starlight est un logiciel en version bêta, il y aura des mises à jour et Assurez-vous de mettre à jour Starlight régulièrement ! ::: -Starlight est une intégration Astro. -Vous pouvez la mettre à jour ainsi que tous autres packages Astro en exécutant la commande suivante dans votre terminal : +Starlight est une intégration Astro. Vous pouvez la mettre à jour ainsi que tous autres packages Astro en exécutant la commande suivante dans votre terminal : diff --git a/docs/src/content/docs/fr/guides/authoring-content.md b/docs/src/content/docs/fr/guides/authoring-content.md index f3c3460b0a4..31a31c3c9b3 100644 --- a/docs/src/content/docs/fr/guides/authoring-content.md +++ b/docs/src/content/docs/fr/guides/authoring-content.md @@ -107,15 +107,15 @@ Les titres de niveau 2 (`

`) et de niveau 3 (`

`) apparaissent automatique Pour en apprendre davantage sur la façon dont Astro traite les attributs `id` des titres de section, consultez la [documentation d'Astro](https://docs.astro.build/fr/guides/markdown-content/#identifiants-den-t%C3%AAte). -## Asides +## Encarts -Les Asides (également connus sous le nom de "callouts") sont utiles pour afficher des informations secondaires à côté du contenu principal d'une page. +Les encarts (également connus sous le nom de « admonitions » ou « asides » en anglais) sont utiles pour afficher des informations secondaires à côté du contenu principal d'une page. -Starlight fournit une syntaxe Markdown personnalisée pour le rendu des apartés. Les blocs d'apartés sont indiqués en utilisant une paire de triples points `:::` pour envelopper votre contenu, et peuvent être de type `note`, `tip`, `caution` ou `danger`. +Starlight fournit une syntaxe Markdown personnalisée pour le rendu des encarts. Les blocs d'encarts sont indiqués en utilisant une paire de triples points `:::` pour envelopper votre contenu, et peuvent être de type `note`, `tip`, `caution` ou `danger`. Vous pouvez imbriquer n'importe quel autre type de contenu Markdown à l'intérieur d'un aparté, mais les aparté sont mieux adaptés à des morceaux de contenu courts et concis. -### Note aside +### Encart de type note :::note Starlight est une boîte à outils pour sites web de documentation construite avec [Astro](https://astro.build/). Vous pouvez démarrer avec cette commande : @@ -137,9 +137,9 @@ npm run create astro@latest --template starlight ::: ```` -### Titres personnalisés dans les asides +### Titres personnalisés dans les encarts -Vous pouvez spécifier un titre personnalisé pour l'aparté entre crochets après le type d'aparté, par exemple `:::tip[Le saviez-vous ?]`. +Vous pouvez spécifier un titre personnalisé pour l'encart entre crochets après le type d'encarts, par exemple `:::tip[Le saviez-vous ?]`. :::tip[Le saviez-vous ?] Astro vous aide à construire des sites Web plus rapides grâce à ["Islands Architecture"](https://docs.astro.build/fr/concepts/islands/). @@ -151,9 +151,9 @@ Astro vous aide à construire des sites Web plus rapides grâce à ["Islands Arc ::: ``` -### Plus de types pour l'aside +### Plus de types d'encarts -Les apartés de type Attention et Danger sont utiles pour attirer l'attention de l'utilisateur sur des détails qui pourraient le perturber. Si vous vous retrouvez à utiliser ces derniers fréquemment, cela pourrait aussi être un signe que ce que vous documentez pourrait bénéficier d'une refonte. +Les encarts de type Attention et Danger sont utiles pour attirer l'attention de l'utilisateur sur des détails qui pourraient le perturber. Si vous vous retrouvez à utiliser ces derniers fréquemment, cela pourrait aussi être un signe que ce que vous documentez pourrait bénéficier d'une refonte. :::caution Si vous n'êtes pas sûr de vouloir un site de documentation génial, réfléchissez à deux fois avant d'utiliser [Starlight](/fr/). diff --git a/docs/src/content/docs/fr/guides/components.mdx b/docs/src/content/docs/fr/guides/components.mdx index faea326b756..b504e78c5b7 100644 --- a/docs/src/content/docs/fr/guides/components.mdx +++ b/docs/src/content/docs/fr/guides/components.mdx @@ -179,6 +179,61 @@ import { LinkCard } from '@astrojs/starlight/components'; +### Encarts + +Les encarts (également connus sous le nom de « admonitions » ou « asides » en anglais) sont utiles pour afficher des informations secondaires à côté du contenu principal d'une page. + +Le composant `