diff --git a/docs/src/content/docs/es/getting-started.mdx b/docs/src/content/docs/es/getting-started.mdx index dbe79dd7c89..5ac0e3356f8 100644 --- a/docs/src/content/docs/es/getting-started.mdx +++ b/docs/src/content/docs/es/getting-started.mdx @@ -15,7 +15,7 @@ Consulta las [instrucciones de configuración manual](/es/manual-setup/) para ag Crea un nuevo proyecto de Astro + Starlight ejecutando el siguiente comando en tu terminal: - + ```sh @@ -52,7 +52,7 @@ Cuando trabajas localmente, el [servidor de desarrollo de Astro](https://docs.as Dentro del directorio de tu proyecto, ejecuta el siguiente comando para iniciar el servidor de desarrollo: - + ```sh @@ -103,7 +103,7 @@ Debido a que Starlight es un software beta, habrá actualizaciones y mejoras fre Starlight es una integración Astro. Puedes actualizarlo y otros paquetes de Astro ejecutando el siguiente comando en tu terminal: - + ```sh diff --git a/docs/src/content/docs/es/guides/components.mdx b/docs/src/content/docs/es/guides/components.mdx index 9072b8d9cfc..71e6249cd85 100644 --- a/docs/src/content/docs/es/guides/components.mdx +++ b/docs/src/content/docs/es/guides/components.mdx @@ -84,6 +84,50 @@ El código anterior genera las siguientes pestañas en la página: +#### Pestañas sincronizadas + +Manten varias pestañas sincronizadas añadiendo el atributo `syncKey`. + +Todas las `` en una página con el mismo valor de `syncKey` mostrarán la misma etiqueta activa. Esto permite a tu lector elegir una vez (por ejemplo, su sistema operativo o gestor de paquetes) y ver su elección reflejada en toda la página. + +Para sincronizar pestañas relacionadas, añade una propiedad `syncKey` idéntica a cada componente `` y asegúrate de que todos usen las mismas etiquetas ``: + +```mdx 'syncKey="constellations"' +# src/content/docs/example.mdx + +import { Tabs, TabItem } from '@astrojs/starlight/components'; + +_Algunas estrellas:_ + + + Bellatrix, Rigel, Betelgeuse + Pollux, Cástor A, Cástor B + + +_Algunos exoplanetas:_ + + + HD 34445 b, Gliese 179 b, Wasp-82 b + Pollux b, HAT-P-24b, HD 50554 b + +``` + +El código anterior genera lo siguiente en la página: + +_Algunas estrellas:_ + + + Bellatrix, Rigel, Betelgeuse + Pollux, Cástor A, Cástor B + + +_Algunos exoplanetas:_ + + + HD 34445 b, Gliese 179 b, Wasp-82 b + Pollux b, HAT-P-24b, HD 50554 b + + ### Tarjetas import { Card, CardGrid } from '@astrojs/starlight/components'; diff --git a/docs/src/content/docs/es/guides/css-and-tailwind.mdx b/docs/src/content/docs/es/guides/css-and-tailwind.mdx index b3ef9449b07..418d67b92bc 100644 --- a/docs/src/content/docs/es/guides/css-and-tailwind.mdx +++ b/docs/src/content/docs/es/guides/css-and-tailwind.mdx @@ -63,7 +63,7 @@ El plugin Starlight Tailwind aplica la siguiente configuración: Empieza un nuevo proyecto en Starlight con Tailwind CSS preconfigurado usando `create astro`: - + ```sh @@ -95,7 +95,7 @@ Si ya tienes un sitio en Starlight y quieres agregar Tailwind CSS, sigue estos p 1. Agrega la integración de Tailwind de Astro: - + @@ -125,7 +125,7 @@ Si ya tienes un sitio en Starlight y quieres agregar Tailwind CSS, sigue estos p 2. Instala el plugin Starlight Tailwind: - + diff --git a/docs/src/content/docs/es/guides/customization.mdx b/docs/src/content/docs/es/guides/customization.mdx index 8ac23cfaf1e..67f40b04ad6 100644 --- a/docs/src/content/docs/es/guides/customization.mdx +++ b/docs/src/content/docs/es/guides/customization.mdx @@ -127,7 +127,7 @@ Starlight muestra una tabla de contenidos en cada página para facilitar que los De forma predeterminada, los encabezados `

` y `

` se incluyen en la tabla de contenidos. Puedes cambiar qué niveles de encabezados se incluyen en toda la página utilizando las opciones `minHeadingLevel` y `maxHeadingLevel` en tu configuración [global de `tableOfContents`](/es/reference/configuration/#tableofcontents). Puedes anular estas configuraciones predeterminadas en una página individual agregando las propiedades correspondientes de [`tableOfContents` en el frontmatter](/es/reference/frontmatter/#tableofcontents): - + ```md {4-6} @@ -161,7 +161,7 @@ defineConfig({ Desactiva completamente la tabla de contenidos estableciendo la opción `tableOfContents` en `false`: - + ```md {4} diff --git a/docs/src/content/docs/es/guides/i18n.mdx b/docs/src/content/docs/es/guides/i18n.mdx index 8e86ff5784d..05227db1096 100644 --- a/docs/src/content/docs/es/guides/i18n.mdx +++ b/docs/src/content/docs/es/guides/i18n.mdx @@ -142,6 +142,34 @@ Starlight espera que crees páginas equivalentes en todos tus idiomas. Por ejemp Si no hay una traducción disponible para un idioma, Starlight mostrará a los lectores el contenido de esa página en el idioma predeterminado (establecido mediante `defaultLocale`). Por ejemplo, si aún no has creado una versión en francés de tu página Acerca de y tu idioma predeterminado es el inglés, los visitantes a `/fr/about` verán el contenido en inglés de `/en/about` con un aviso de que esta página aún no se ha traducido. Esto te ayuda a agregar contenido en tu idioma predeterminado y luego traducirlo progresivamente cuando tus traductores tengan tiempo. +## Traduce el título del sitio + +Por defecto, Starlight usará el mismo título del sitio para todos los idiomas. +Si necesitas personalizar el título para cada idioma, puedes pasar un objeto a [`title`](/es/reference/configuration/#title-requerido) en las opciones de Starlight: + +```diff lang="js" +// astro.config.mjs +import { defineConfig } from 'astro/config'; +import starlight from '@astrojs/starlight'; + +export default defineConfig({ + integrations: [ + starlight({ +- title: 'Mi Documentación', ++ title: { ++ es: 'Mi Documentación', ++ 'zh-CN': '我的文档', ++ }, + defaultLocale: 'es', + locales: { + es: { label: 'Español' }, + 'zh-cn': { label: '简体中文', lang: 'zh-CN' }, + }, + }), + ], +}); +``` + ## Traduce la UI de Starlight import LanguagesList from '~/components/languages-list.astro'; diff --git a/docs/src/content/docs/es/guides/pages.mdx b/docs/src/content/docs/es/guides/pages.mdx index 9ff7d8a946a..7506a490759 100644 --- a/docs/src/content/docs/es/guides/pages.mdx +++ b/docs/src/content/docs/es/guides/pages.mdx @@ -105,6 +105,7 @@ 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. +- La opción [`draft`](/es/reference/frontmatter/#draft) solo muestra un [aviso](/es/reference/overrides/#draftcontentnotice) de que la página es un borrador, pero no la excluye automáticamente de las compilaciones de producción. ##### `sidebar` diff --git a/docs/src/content/docs/es/reference/configuration.mdx b/docs/src/content/docs/es/reference/configuration.mdx index 460980f516d..2f0981ac445 100644 --- a/docs/src/content/docs/es/reference/configuration.mdx +++ b/docs/src/content/docs/es/reference/configuration.mdx @@ -24,10 +24,22 @@ Puedes pasar las siguientes opciones a la integración `starlight`. ### `title` (requerido) -**tipo:** `string` +**tipo:** `string | Record` Establece el título de tu sitio web. Se utilizará en los metadatos y en el título de la pestaña del navegador. +El valor puede ser un string o para sitios multilingües, un objeto con valores para cada idioma diferente. +Cuando se usa la forma de objeto, las claves deben ser etiquetas BCP-47 (por ejemplo, `en`, `ar` o `zh-CN`): + +```ts +starlight({ + title: { + es: 'Mi encantador sitio de documentación', + de: 'Meine bezaubernde Dokumentationsseite', + }, +}); +``` + ### `description` **tipo:** `string` diff --git a/docs/src/content/docs/es/reference/frontmatter.md b/docs/src/content/docs/es/reference/frontmatter.md index ddc07b2bc89..f7645f786d5 100644 --- a/docs/src/content/docs/es/reference/frontmatter.md +++ b/docs/src/content/docs/es/reference/frontmatter.md @@ -270,6 +270,21 @@ pagefind: false --- ``` +### `draft` + +**tipo:** `boolean` +**por defecto:** `false` + +Establece si esta página debe considerarse como un borrador y no incluirse en las [compilaciones de producción](https://docs.astro.build/es/reference/cli-reference/#astro-build) y [grupos de enlaces autogenerados](/es/guides/sidebar/#grupos-autogenerados). Establece en `true` para marcar una página como borrador y hacerla visible solo durante el desarrollo. + +```md +--- +# src/content/docs/example.md +# Excluye esta página de las compilaciones de producción +draft: true +--- +``` + ### `sidebar` **tipo:** [`SidebarConfig`](#sidebarconfig) diff --git a/docs/src/content/docs/es/reference/overrides.md b/docs/src/content/docs/es/reference/overrides.md index 4f036c372d7..9e6806a86f8 100644 --- a/docs/src/content/docs/es/reference/overrides.md +++ b/docs/src/content/docs/es/reference/overrides.md @@ -51,6 +51,12 @@ Etiqueta de idioma BCP-47 para la configuración regional de esta página, por e La ruta base en la que se sirve un idioma. `undefined` para los slugs de idioma raíz. +#### `siteTitle` + +**Tipo:** `string` + +El título del sitio para el idioma de esta página. + #### `slug` **Tipo:** `string` @@ -219,7 +225,7 @@ Estos componentes renderizan la barra de navegación superior de Starlight. **Componente por defecto:** [`Header.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Header.astro) Componente de encabezado que se muestra en la parte superior de cada página. -La implementación predeterminada muestra [``](#sitetitle), [``](#search), [``](#socialicons), [``](#themeselect) y [``](#languageselect). +La implementación predeterminada muestra [``](#sitetitle-1), [``](#search), [``](#socialicons), [``](#themeselect) y [``](#languageselect). #### `SiteTitle` @@ -331,6 +337,12 @@ Componente que contiene el elemento `

` de la página actual. Las implementaciones deben asegurarse de establecer `id="_top"` en el elemento `

` como en la implementación predeterminada. +#### `DraftContentNotice` + +**Componente por defecto:** [`DraftContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/DraftContentNotice.astro) + +Aviso mostrado a los usuarios durante el desarrollo cuando la página actual está marcada como borrador. + #### `FallbackContentNotice` **Componente por defecto:** [`FallbackContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/FallbackContentNotice.astro) diff --git a/docs/src/content/docs/es/resources/community-content.mdx b/docs/src/content/docs/es/resources/community-content.mdx index 1cd5a3b5356..5ec55f26910 100644 --- a/docs/src/content/docs/es/resources/community-content.mdx +++ b/docs/src/content/docs/es/resources/community-content.mdx @@ -128,5 +128,12 @@ import YouTubeGrid from '~/components/youtube-grid.astro'; description: 'Pon en marcha un nuevo sitio de Starlight en unos 5 minutos', }, + { + href: 'https://www.youtube.com/watch?v=12o7WxjAxjM', + title: + 'Incluye la documentación de Starlight en un proyecto de Next.js con proxies', + description: + 'Configura Starlight como un proyecto de subdirectorio dentro de un sitio web de Next.js', + }, ]} /> diff --git a/docs/src/content/docs/fr/getting-started.mdx b/docs/src/content/docs/fr/getting-started.mdx index 4c38de663f3..7c00093bbde 100644 --- a/docs/src/content/docs/fr/getting-started.mdx +++ b/docs/src/content/docs/fr/getting-started.mdx @@ -15,7 +15,7 @@ Consultez les [instructions d'installation manuelle](/fr/manual-setup/) pour ajo Créez un nouveau projet Astro + Starlight en lançant la commande suivante dans votre terminal : - + ```sh @@ -52,7 +52,7 @@ Lorsque vous travaillez localement, [le serveur de développement d'Astro](https À l'intérieur du répertoire de votre projet, exécutez la commande suivante pour démarrer le serveur de développement : - + ```sh @@ -103,7 +103,7 @@ 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 : - + ```sh diff --git a/docs/src/content/docs/fr/guides/components.mdx b/docs/src/content/docs/fr/guides/components.mdx index e9e13b4a970..94f5e93fdf3 100644 --- a/docs/src/content/docs/fr/guides/components.mdx +++ b/docs/src/content/docs/fr/guides/components.mdx @@ -87,6 +87,51 @@ Le code ci-dessus génère les onglets suivants sur la page : +#### Onglets synchronisés + +Conservez plusieurs groupes d'onglets synchronisés en ajoutant l'attribut `syncKey`. + +Tous les composants `` sur une page avec la même valeur `syncKey` afficheront le même label actif. +Cela permet à votre lecteur de choisir une fois (par exemple, leur système d'exploitation ou leur gestionnaire de paquets) et de voir leur choix reflété sur l'ensemble de la page. + +Pour synchroniser des onglets liés, ajoutez une propriété `syncKey` identique à chaque composant `` et assurez-vous qu'ils utilisent tous les mêmes libellés de `` : + +```mdx 'syncKey="constellations"' +# src/content/docs/exemple.mdx + +import { Tabs, TabItem } from '@astrojs/starlight/components'; + +_Quelques étoiles :_ + + + Bellatrix, Rigel, Bételgeuse + Pollux, Castor A, Castor B + + +_Quelques exoplanètes :_ + + + HD 34445 b, Gliese 179 b, Wasp-82 b + Pollux b, HAT-P-24b, HD 50554 b + +``` + +Le code ci-dessus génère les onglets suivants sur la page : + +_Quelques étoiles :_ + + + Bellatrix, Rigel, Bételgeuse + Pollux, Castor A, Castor B + + +_Quelques exoplanètes :_ + + + HD 34445 b, Gliese 179 b, Wasp-82 b + Pollux b, HAT-P-24b, HD 50554 b + + ### Cartes import { Card, CardGrid } from '@astrojs/starlight/components'; diff --git a/docs/src/content/docs/fr/guides/css-and-tailwind.mdx b/docs/src/content/docs/fr/guides/css-and-tailwind.mdx index 2a2da0fd59a..63f34201198 100644 --- a/docs/src/content/docs/fr/guides/css-and-tailwind.mdx +++ b/docs/src/content/docs/fr/guides/css-and-tailwind.mdx @@ -63,7 +63,7 @@ Le module d'extension Tailwind de Starlight applique la configuration suivante : Démarrez un nouveau projet Starlight avec Tailwind CSS préconfiguré en utilisant `create astro` : - + ```sh @@ -95,7 +95,7 @@ Si vous avez déjà un site Starlight et que vous souhaitez ajouter Tailwind CSS 1. Ajoutez l'intégration Astro pour Tailwind : - + @@ -125,7 +125,7 @@ Si vous avez déjà un site Starlight et que vous souhaitez ajouter Tailwind CSS 2. Installez le module d'extension Tailwind de Starlight : - + diff --git a/docs/src/content/docs/fr/guides/customization.mdx b/docs/src/content/docs/fr/guides/customization.mdx index efaab45ae40..f9cd3ced786 100644 --- a/docs/src/content/docs/fr/guides/customization.mdx +++ b/docs/src/content/docs/fr/guides/customization.mdx @@ -130,7 +130,7 @@ Vous pouvez personnaliser - ou même désactiver - la table des matières global Par défaut, les titres `

` et `

` sont inclus dans la table des matières. Modifiez les niveaux de titres à inclure à l’échelle du site à l’aide des options `minHeadingLevel` et `maxHeadingLevel` dans votre option de configuration [globale `tableOfContents`](/fr/reference/configuration/#tableofcontents). Remplacez ces valeurs par défaut sur une page individuelle en ajoutant les propriétés [frontmatter `tableOfContents`](/fr/reference/frontmatter/#tableofcontents) correspondantes : - + ```md {4-6} @@ -164,7 +164,7 @@ defineConfig({ Désactivez la table des matières complètement en définissant l’option `tableOfContents` à `false`: - + ```md {4} diff --git a/docs/src/content/docs/fr/guides/i18n.mdx b/docs/src/content/docs/fr/guides/i18n.mdx index a1592cdc195..e02ef168b09 100644 --- a/docs/src/content/docs/fr/guides/i18n.mdx +++ b/docs/src/content/docs/fr/guides/i18n.mdx @@ -143,6 +143,34 @@ Starlight s'attend à ce que vous créiez des pages équivalentes dans toutes vo Si une traduction n'est pas encore disponible pour une langue, Starlight affichera aux lecteurs le contenu de cette page dans la langue par défaut (définie via `defaultLocale`). Par exemple, si vous n'avez pas encore créé de version française de votre page À propos et que votre langue par défaut est l'anglais, les visiteurs de `/fr/about` verront le contenu anglais de `/en/about` avec un avis indiquant que cette page n'a pas encore été traduite. Cela vous permet d'ajouter du contenu dans votre langue par défaut et de le traduire progressivement lorsque vos traducteurs en ont le temps. +## Traduire le titre du site + +Par défaut, Starlight utilisera le même titre de site pour toutes les langues. +Si vous avez besoin de personnaliser le titre pour chaque langue, vous pouvez passer un objet à [`title`](/fr/reference/configuration/#title-obligatoire) dans les options de Starlight : + +```diff lang="js" +// astro.config.mjs +import { defineConfig } from 'astro/config'; +import starlight from '@astrojs/starlight'; + +export default defineConfig({ + integrations: [ + starlight({ +- title: 'Ma documentation', ++ title: { ++ fr: 'Ma documentation', ++ 'zh-CN': '我的文档', ++ }, + defaultLocale: 'fr', + locales: { + fr: { label: 'Français' }, + 'zh-cn': { label: '简体中文', lang: 'zh-CN' }, + }, + }), + ], +}); +``` + ## Traduire l'interface utilisateur de Starlight import LanguagesList from '~/components/languages-list.astro'; diff --git a/docs/src/content/docs/fr/guides/pages.mdx b/docs/src/content/docs/fr/guides/pages.mdx index d784f74ca37..047b9fefdd4 100644 --- a/docs/src/content/docs/fr/guides/pages.mdx +++ b/docs/src/content/docs/fr/guides/pages.mdx @@ -105,6 +105,7 @@ 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) 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 `` ne font pas partie d'une collection et ne peuvent pas être ajoutées à un groupe de liens autogénérés. +- L'option [`draft`](/fr/reference/frontmatter/#draft) affiche uniquement une [note](/fr/reference/overrides/#draftcontentnotice) indiquant que la page est une ébauche, mais ne l'exclut pas automatiquement des déploiements en production. ##### `sidebar` diff --git a/docs/src/content/docs/fr/reference/configuration.mdx b/docs/src/content/docs/fr/reference/configuration.mdx index 35e689c23bd..25a44952762 100644 --- a/docs/src/content/docs/fr/reference/configuration.mdx +++ b/docs/src/content/docs/fr/reference/configuration.mdx @@ -25,10 +25,22 @@ Vous pouvez passer les options suivantes à l'intégration `starlight`. ### `title` (obligatoire) -**Type :** `string` +**Type :** `string | Record` Définissez le titre de votre site web. Il sera utilisé dans les métadonnées et dans le titre de l'onglet du navigateur. +La valeur peut être une chaîne de caractères, ou pour les sites multilingues, un objet avec des valeurs pour chacune des différentes locales. +Lorsque vous utilisez la forme objet, les clés doivent être des étiquettes d'identification BCP-47 (par exemple `fr`, `ar`, ou `zh-CN`) : + +```ts +starlight({ + title: { + fr: 'Mon délicieux site de docs', + de: 'Meine bezaubernde Dokumentationsseite', + }, +}); +``` + ### `description` **Type :** `string` diff --git a/docs/src/content/docs/fr/reference/frontmatter.md b/docs/src/content/docs/fr/reference/frontmatter.md index 5f8e55b0fa5..be462d60d85 100644 --- a/docs/src/content/docs/fr/reference/frontmatter.md +++ b/docs/src/content/docs/fr/reference/frontmatter.md @@ -268,6 +268,21 @@ pagefind: false --- ``` +### `draft` + +**Type :** `boolean` +**Par défaut :** `false` + +Définit si cette page doit être considérée comme une ébauche et ne pas être incluse dans les [déploiements en production](https://docs.astro.build/fr/reference/cli-reference/#astro-build) et les [groupes de liens générés automatiquement](/fr/guides/sidebar/#groupes-générés-automatiquement). Définissez la valeur à `true` pour marquer une page comme une ébauche et la rendre visible uniquement pendant le développement. + +```md +--- +# src/content/docs/exemple.md +# Exclure cette page des déploiements en production +draft: true +--- +``` + ### `sidebar` **Type :** [`SidebarConfig`](#sidebarconfig) diff --git a/docs/src/content/docs/fr/reference/overrides.md b/docs/src/content/docs/fr/reference/overrides.md index 1f821b7fd75..99b8e204650 100644 --- a/docs/src/content/docs/fr/reference/overrides.md +++ b/docs/src/content/docs/fr/reference/overrides.md @@ -50,6 +50,12 @@ L’étiquette d’identification BCP-47 pour la langue de la page, par exemple Le chemin de base utilisé pour servir une langue. `undefined` pour les slugs de la locale racine. +#### `siteTitle` + +**Type :** `string` + +Le titre du site pour la langue de cette page. + #### `slug` **Type :** `string` @@ -218,7 +224,7 @@ Ces composants affichent la barre de navigation supérieure de Starlight. **Composant par défaut :** [`Header.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Header.astro) Composant d'en-tête affiché en haut de chaque page. -L'implémentation par défaut affiche [``](#sitetitle), [``](#search), [``](#socialicons), [``](#themeselect) et [``](#languageselect). +L'implémentation par défaut affiche [``](#sitetitle-1), [``](#search), [``](#socialicons), [``](#themeselect) et [``](#languageselect). #### `SiteTitle` @@ -332,6 +338,12 @@ Composant contenant l'élement `

` de la page courante. Les implémentations personnalisées doivent s'assurer qu'elles définissent `id="_top"` sur l'élément `

` comme dans l'implémentation par défaut. +#### `DraftContentNotice` + +**Composant par défaut :** [`DraftContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/DraftContentNotice.astro) + +Note affichée aux utilisateurs durant le développement lorsque la page actuelle est marquée comme une ébauche. + #### `FallbackContentNotice` **Composant par défaut :** [`FallbackContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/FallbackContentNotice.astro) diff --git a/docs/src/content/docs/pt-br/getting-started.mdx b/docs/src/content/docs/pt-br/getting-started.mdx index 1b708f8e3a2..00cf8aa04dc 100644 --- a/docs/src/content/docs/pt-br/getting-started.mdx +++ b/docs/src/content/docs/pt-br/getting-started.mdx @@ -15,7 +15,7 @@ Consulte as [instruções de instalação manual](/pt-br/manual-setup/) para adi Crie um novo projeto Astro + Starlight executando o seguinte comando em seu terminal: - + ```sh @@ -52,7 +52,7 @@ Quando estiver trabalhando localmente, o [servidor de desenvolvimento do Astro]( Dentro do diretório do seu projeto, execute o seguinte comando para iniciar o servidor de desenvolvimento: - + ```sh @@ -103,7 +103,7 @@ Certifique-se de atualizar Starlight constantemente! Starlight é uma integração Astro. Você pode atualiza-lo e outros pacotes Astro com o seguinte comando em seu terminal: - + ```sh diff --git a/docs/src/content/docs/tr/getting-started.mdx b/docs/src/content/docs/tr/getting-started.mdx index f456c43139d..30bc892066a 100644 --- a/docs/src/content/docs/tr/getting-started.mdx +++ b/docs/src/content/docs/tr/getting-started.mdx @@ -1,21 +1,24 @@ --- title: Başlarken -description: Sıradaki dokümantasyon site Astro'nun Starlight'ı ile nasıl oluşturacağını öğren. +description: Sıradaki dokümantasyon siteni Astro'nun Starlight'ı ile nasıl oluşturacağını öğren. --- import { Tabs, TabItem } from '@astrojs/starlight/components'; -## Yeni Proje Oluşturma +Starlight, [Astro](https://astro.build) çerçevesi üstüne kurulmuş çok özellikli bir dokümantasyon temasıdır. +Bu rehber, yeni projeye başlamanda yardımcı olacak. +Mevcut Astro projesine Starlight eklemek için [elle kurulum talimatlarını](/tr/manual-setup/) incele. -Starlight, Astro çerçevesi üstüne kurulmuş çok özellikli bir dokümantasyon temasıdır. +## Hızlı Başlangıç -Aşağıdaki komutları kullanarak yeni bir Astro + Starlight projesi oluşturabilirsin: +### Yeni Proje Oluşturma - +Aşağıdaki komutu terminalinde çalıştırarak yeni bir Astro + Starlight projesi oluştur: + + ```sh -# npm ile yeni bir proje oluştur npm create astro@latest -- --template starlight ``` @@ -23,7 +26,6 @@ npm create astro@latest -- --template starlight ```sh -# pnpm ile yeni bir proje oluştur pnpm create astro --template starlight ``` @@ -31,7 +33,6 @@ pnpm create astro --template starlight ```sh -# yarn ile yeni bir proje oluştur yarn create astro --template starlight ``` @@ -45,72 +46,82 @@ Starlight'ı tarayıcında dene: [StackBlitz'deki taslağı aç](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics). ::: -## Starlight ile İçerik Oluşturmak +### Geliştirme sunucusunu başlat -Starlight, yeni bir içerik eklemen ya da var olan dosyalarını getirmen için hazır! +[Astro’nun geliştirme sunucusu](https://docs.astro.build/en/reference/cli-reference/#astro-dev) lokalinizde çalışırken, çalışmanızı önizlemeye ve otomatik olarak tarayıcınızın değişiklik yaptığınızda yenilenmesine olanak tanır. -### Dosya Formatları +Geliştirme sunucusunu başlatmak için aşağıdaki komutu proje dizininizde çalıştırın: -Starlight, içerik yazmada Markdown ve MDX formatlarını destekler. (Deneysel [Astro Markdoc entegrasyonu](https://docs.astro.build/en/guides/integrations-guide/markdoc/)'nu yükleyerek Markdoc formatı için destek ekleyebilirsin.) + + -### Sayfa Ekle +```sh +npm run dev +``` -`src/content/docs/` dizini altında `.md` or `.mdx` uzantılı dosya ekleyerek otomatik olarak sitene yeni sayfalar ekle. Dosyalarını organize etmek ve çoklu dizim bölümleri oluşturmak için yeni alt klasörler ekle: + + +```sh +pnpm dev ``` -src/content/docs/hello-world.md => your-site.com/hello-world -src/content/docs/guides/faq.md => your-site.com/guides/faq + + + + +```sh +yarn dev ``` -### Tip-korumalı Ön BÖlüm + + + +Bu, terminalinizde lokal önizleme bağlantılı bir mesaj gösterecektir. +Sitenizi tarayıcıda görüntülemek için bu bağlantıyı açın. -Tüm Starlight sayfaları özelleştirilebilir [ortak ön-bölüm mülkleri seti](/tr/reference/frontmatter/)'ni, sayfaların nasıl görüntüleneceğini kontrol etmek için paylaşır: +### İçerik Ekle -```md ---- -title: Merhaba, Dünya! -description: Bu, Starlight'la hazırlanmış sitemdeki bir sayfadır. ---- -``` +Starlight, yeni bir içerik eklemen ya da var olan dosyalarını getirmen için hazır! -Herhangi önemli bir şeyi unutursan, Starlight sana hatırlatacaktır. +`src/content/docs/` dizini içerisinde yeni Markdown dosyaları oluşturarak yeni sayfalar ekleyin. -## Starlight Web Siteni Yayına Al +Dosya bazlı gezinim ve MDX ile Markdoc dosya desteği hakkında daha fazlası için [“Sayfalar”](/tr/guides/pages/) rehberini okuyun. -Starlight websiteni oluşturduktan ve özelleştirdikten sonra; bir web sunucusunda ya da Netlify, Vercel, GitHub Pages ve daha fazla barındırma platformundan herhangi birinde yayına alabilirsin. +### Sonraki Adımlar -[Astro dokümantasyonunda, bir Astro sitenin nasıl yayına alındığını öğren.](https://docs.astro.build/en/guides/deploy/) +- **Yapılandır:** [“Starlight'ı özelleştirmek”](/tr/guides/customization/) rehberinde ortak ayarlar hakkında öğren. +- **Gezinme:** [“Kenar Çubuğu Gezinimi”](/tr/guides/sidebar/) rehberi ile kenar çubuğunu ayarla. +- **Bileşenler:** [“Bileşenler”](/tr/guides/components/) rehberinde hazır yapılmış kartlar, tablar ve daha fazlasını keşfet. +- **Yayına al:** Astro dokümantayonu içerisindeki [“Siteni yayına al”](https://docs.astro.build/en/guides/deploy/) rehberi ile çalışmanı yayınla. ## Starlight'ı Güncelleme :::tip -Starlight, beta sürümünde olduğundan dolayı sıklıkla güncelleme ve geliştirmeler yapılacak. Starlight'ı güncel tuttuğuna emin ol! +Starlight, beta sürümünde olduğundan dolayı sıklıkla güncelleme ve geliştirmeler yapılacak. +Starlight'ı güncel tuttuğuna emin ol! ::: -Starlight bir Astro entegrasyonudur ve herhangi bir `@astrojs/*` entegrasyonu gibi güncellenir: +Starlight bir Astro entegrasyonudur. Bunu ve diğer Astro paketlerini, terminalinde aşağıdaki komutu çalıştırarak güncelleyebilirsin: - + ```sh -# npm ile Starlight'ı güncelle -npm install @astrojs/starlight@latest +npx @astrojs/upgrade ``` ```sh -# pnpm ile Starlight'ı güncelle -pnpm upgrade @astrojs/starlight --latest +pnpm dlx @astrojs/upgrade ``` ```sh -# yarn ile Starlight'ı güncelle -yarn upgrade @astrojs/starlight --latest +yarn dlx @astrojs/upgrade ``` diff --git a/examples/basics/package.json b/examples/basics/package.json index 2899cd2d223..9b318cea5ef 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.22.0", + "@astrojs/starlight": "^0.22.1", "astro": "^4.3.5", "sharp": "^0.32.5" } diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json index 7d7e5d229f9..cad21e9cb7d 100644 --- a/examples/tailwind/package.json +++ b/examples/tailwind/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.22.0", + "@astrojs/starlight": "^0.22.1", "@astrojs/starlight-tailwind": "^2.0.2", "@astrojs/tailwind": "^5.1.0", "astro": "^4.3.5", diff --git a/packages/starlight/CHANGELOG.md b/packages/starlight/CHANGELOG.md index a61d9f9a07f..679eff5ed28 100644 --- a/packages/starlight/CHANGELOG.md +++ b/packages/starlight/CHANGELOG.md @@ -1,5 +1,11 @@ # @astrojs/starlight +## 0.22.1 + +### Patch Changes + +- [`1c0fc384`](https://github.com/withastro/starlight/commit/1c0fc3849771713d5a3e7a572bdbf1483ae5551b) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue where the `siteTitle` property would not be set when using the `` component. + ## 0.22.0 ### Minor Changes diff --git a/packages/starlight/__tests__/basics/starlight-page-route-data.test.ts b/packages/starlight/__tests__/basics/starlight-page-route-data.test.ts index 95f611e255c..e5164e04108 100644 --- a/packages/starlight/__tests__/basics/starlight-page-route-data.test.ts +++ b/packages/starlight/__tests__/basics/starlight-page-route-data.test.ts @@ -1,4 +1,6 @@ import { assert, expect, test, vi } from 'vitest'; +import { generateRouteData } from '../../utils/route-data'; +import { routes } from '../../utils/routing'; import { generateStarlightPageRouteData, type StarlightPageProps, @@ -46,6 +48,7 @@ test('adds data to route shape', async () => { // Starlight pages respect the passed data. expect(data.entry.data.title).toBe(starlightPageProps.frontmatter.title); // Starlight pages get expected defaults. + expect(data.siteTitle).toBe('Basics'); expect(data.hasSidebar).toBe(true); expect(data.headings).toEqual([]); expect(data.entryMeta.dir).toBe('ltr'); @@ -494,3 +497,18 @@ test('strips unknown frontmatter properties', async () => { }); expect('unknown' in data.entry.data).toBe(false); }); + +test('generates data with a similar root shape to regular route data', async () => { + const route = routes[0]!; + const data = generateRouteData({ + props: { ...route, headings: [{ depth: 1, slug: 'heading-1', text: 'Heading 1' }] }, + url: new URL('https://example.com'), + }); + + const starlightPageData = await generateStarlightPageRouteData({ + props: starlightPageProps, + url: starlightPageUrl, + }); + + expect(Object.keys(data).sort()).toEqual(Object.keys(starlightPageData).sort()); +}); diff --git a/packages/starlight/package.json b/packages/starlight/package.json index e0ebde3ad2a..059b2ba8acc 100644 --- a/packages/starlight/package.json +++ b/packages/starlight/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight", - "version": "0.22.0", + "version": "0.22.1", "description": "Build beautiful, high-performance documentation websites with Astro", "scripts": { "test": "vitest", diff --git a/packages/starlight/utils/route-data.ts b/packages/starlight/utils/route-data.ts index f9c6717de98..a47e68f262f 100644 --- a/packages/starlight/utils/route-data.ts +++ b/packages/starlight/utils/route-data.ts @@ -111,7 +111,7 @@ function getEditUrl({ entry, id, isFallback }: PageProps): URL | undefined { } /** Get the site title for a given language. **/ -function getSiteTitle(lang: string): string { +export function getSiteTitle(lang: string): string { const defaultLang = config.defaultLocale.lang as string; if (lang && config.title[lang]) { return config.title[lang] as string; diff --git a/packages/starlight/utils/starlight-page.ts b/packages/starlight/utils/starlight-page.ts index 88fbef872cc..e736457bbb5 100644 --- a/packages/starlight/utils/starlight-page.ts +++ b/packages/starlight/utils/starlight-page.ts @@ -3,7 +3,7 @@ import { type ContentConfig, type SchemaContext } from 'astro:content'; import config from 'virtual:starlight/user-config'; import { parseWithFriendlyErrors } from './error-map'; import { stripLeadingAndTrailingSlashes } from './path'; -import { getToC, type PageProps, type StarlightRouteData } from './route-data'; +import { getSiteTitle, getToC, type PageProps, type StarlightRouteData } from './route-data'; import type { StarlightDocsEntry } from './routing'; import { slugToLocaleData, urlToSlug } from './slugs'; import { getPrevNextLinks, getSidebar } from './navigation'; @@ -223,6 +223,7 @@ export async function generateStarlightPageRouteData({ lastUpdated, pagination: getPrevNextLinks(sidebar, config.pagination, entry.data), sidebar, + siteTitle: getSiteTitle(localeData.lang), slug, toc: getToC({ ...routeProps, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index cd2e1ce9573..1094b3f4ba5 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -67,7 +67,7 @@ importers: examples/basics: dependencies: '@astrojs/starlight': - specifier: ^0.22.0 + specifier: ^0.22.1 version: link:../../packages/starlight astro: specifier: ^4.3.5 @@ -79,7 +79,7 @@ importers: examples/tailwind: dependencies: '@astrojs/starlight': - specifier: ^0.22.0 + specifier: ^0.22.1 version: link:../../packages/starlight '@astrojs/starlight-tailwind': specifier: ^2.0.2