Skip to content

Commit

Permalink
Merge branch 'main' into hd-docs-languages-refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
delucis authored Nov 9, 2023
2 parents eea22dc + f77c6c0 commit d546667
Show file tree
Hide file tree
Showing 55 changed files with 608 additions and 220 deletions.
5 changes: 5 additions & 0 deletions .changeset/quiet-humans-lie.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/starlight': patch
---

Fix last updated dates for pages displaying fallback content
3 changes: 0 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@
- What does this PR change? Give us a brief description.
- Did you change something visual? A before/after screenshot can be helpful.

<!-- TAKING PART IN HACKTOBERFEST? LET US KNOW! -->
<!-- See https://github.com/withastro/docs/blob/main/.github/hacktoberfest.md for more details. -->

<!--
Here’s what will happen next:
One or more of our maintainers will take a look and may ask you to make changes.
Expand Down
3 changes: 2 additions & 1 deletion docs/src/components/about-astro.astro
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ interface Props {
const { title } = Astro.props;
---

<article class="sl-flex not-content" aria-labelledby="about-astro-heading">
<article class="sl-flex" aria-labelledby="about-astro-heading">
<small id="about-astro-heading">
{title}
<span class="sr-only">Astro</span>
Expand Down Expand Up @@ -37,6 +37,7 @@ const { title } = Astro.props;
}
article > :global(*) {
max-width: 50ch;
margin-top: 0 !important;
}
small {
color: var(--sl-color-gray-3);
Expand Down
2 changes: 2 additions & 0 deletions docs/src/components/file-tree.astro
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const processedContent = await fileTreeProcessor.process({
<style is:global>
file-tree {
--x-space: 1.5rem;
--y-space: 0.125rem;
--y-pad: 0;

display: block;
Expand Down Expand Up @@ -88,6 +89,7 @@ const processedContent = await fileTreeProcessor.process({
}

file-tree li {
margin: var(--y-space) 0;
padding: var(--y-pad) 0;
}

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/de/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Eine vollständige Liste der Änderungen findest du im [Starlight Changelog](htt

## Fehlerbehebung

Sowohl die Starlight [Projektkonfiguration](/reference/configuration/) als auch die [Konfiguration einzelner Seiten](/reference/frontmatter/) findest du im Referenzbereich dieser Website. Nutze diese Seiten, um sicherzustellen, dass deine Starlight-Site richtig konfiguriert ist und funktioniert.
Sowohl die Starlight [Projektkonfiguration](/de/reference/configuration/) als auch die [Konfiguration einzelner Seiten](/de/reference/frontmatter/) findest du im Referenzbereich dieser Website. Nutze diese Seiten, um sicherzustellen, dass deine Starlight-Site richtig konfiguriert ist und funktioniert.

In der wachsenden Liste der Anleitungen in der Seitenleiste findest du Hilfe beim Hinzufügen von Inhalten und beim Anpassen deiner Starlight-Website.

Expand Down
4 changes: 4 additions & 0 deletions docs/src/content/docs/de/guides/authoring-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,3 +207,7 @@ Lange, einzeilige Codeblöcke sollten nicht umgebrochen werden. Sie sollten hori
## Andere allgemeine Markdown-Funktionen

Starlight unterstützt alle anderen Markdown-Autorensyntaxen, wie Listen und Tabellen. Einen schnellen Überblick über alle Markdown-Syntaxelemente findest du im [Markdown Cheat Sheet von The Markdown Guide](https://www.markdownguide.org/cheat-sheet/).

## Erweiterte Markdown- und MDX-Konfiguration

Starlight verwendet Astros Markdown- und MDX-Renderer, der auf remark und rehype aufbaut. Du kannst eine Unterstützung für eigene Syntax und Verhalten hinzufügen, indem du `remarkPlugins` oder `rehypePlugins` in deiner Astro-Konfigurationsdatei hinzufügst. Weitere Informationen findest du unter ["Markdown konfigurieren"] (https://docs.astro.build/de/guides/markdown-content/#markdown-konfigurieren) in der Astro-Dokumentation.
2 changes: 1 addition & 1 deletion docs/src/content/docs/de/guides/i18n.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Wenn für eine Sprache noch keine Übersetzung verfügbar ist, zeigt Starlight d

Starlight bietet nicht nur übersetzte Inhaltsdateien, sondern auch die Möglichkeit, die Standard-Benutzeroberfläche zu übersetzen (z.B. die Überschrift "Auf dieser Seite" im Inhaltsverzeichnis), so dass deine Leser deine Website vollständig in der ausgewählten Sprache erleben können.

Englisch, Tschechisch, Französisch, Deutsch, Italienisch, Japanisch, Portugiesisch, Niederländisch, Dänisch, Spanisch, Türkisch, Arabisch, Norwegisch, Farsi, Hebräisch, Chinesisch (vereinfacht), Koreanisch, Indonesisch, Russisch, Schwedisch, Ukrainisch und Vietnamesisch werden standardmäßig übersetzt, und wir freuen uns über [Beiträge zur Aufnahme weiterer Standardsprachen](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md).
Englisch, Tschechisch, Französisch, Deutsch, Italienisch, Japanisch, Portugiesisch, Niederländisch, Dänisch, Spanisch, Türkisch, Arabisch, Norwegisch, Farsi, Hebräisch, Chinesisch (vereinfacht), Koreanisch, Indonesisch, Russisch, Schwedisch, Ukrainisch, Vietnamesisch und Galizisch werden standardmäßig übersetzt, und wir freuen uns über [Beiträge zur Aufnahme weiterer Standardsprachen](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md).

Du kannst Übersetzungen für zusätzliche Sprachen, die du unterstützt, über die `i18n` Datensammlung zur Verfügung stellen - oder unsere Standardbezeichnungen überschreiben.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/de/guides/sidebar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Wird die folgende Seitenleiste automatisch generiert:
]}
/>

Erfahre mehr über autogenerierte Seitenleisten im Abschnitt [autogenerierte Gruppen](#autogenerierte-gruppen).
Erfahre mehr über autogenerierte Seitenleisten im Abschnitt [autogenerierte Gruppen](#automatisch-erzeugte-gruppen).

## Links und Linkgruppen hinzufügen

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/de/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,10 @@ sidebar: [
type SidebarItem = {
label: string;
translations?: Record<string, string>;
badge?: string | BadgeConfig;
} & (
| {
link: string;
badge?: string | BadgeConfig;
attrs?: Record<string, string | number | boolean | undefined>;
}
| { items: SidebarItem[]; collapsed?: boolean }
Expand Down
100 changes: 72 additions & 28 deletions docs/src/content/docs/es/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,34 @@ description: Aprende cómo empezar a construir tu próximo sitio de documentaci

import { Tabs, TabItem } from '@astrojs/starlight/components';

## Creando un nuevo proyecto

Starlight es un tema de documentación completo construido sobre el framework [Astro](https://astro.build).
Esta guía te ayudará a comenzar con un nuevo proyecto.
Consulta las [instrucciones de configuración manual](/es/manual-setup/) para agregar Starlight a un proyecto de Astro existente.

## Inicio rápido

Puedes crear un nuevo proyecto de Astro + Starlight utilizando el siguiente comando:
### Crea un nuevo proyecto

Crea un nuevo proyecto de Astro + Starlight ejecutando el siguiente comando en tu terminal:

<Tabs>
<TabItem label="npm">

```sh
# crear un nuevo proyecto con npm
npm create astro@latest -- --template starlight
```

</TabItem>
<TabItem label="pnpm">

```sh
# crear un nuevo proyecto con pnpm
pnpm create astro --template starlight
```

</TabItem>
<TabItem label="Yarn">

```sh
# crear un nuevo proyecto con yarn
yarn create astro --template starlight
```

Expand All @@ -45,24 +46,68 @@ Prueba Starlight en tu navegador:
[abre la plantilla en StackBlitz](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics).
:::

## Creando contenido con Starlight
### Inicia el servidor de desarrollo

Starlight está listo para que añadas nuevo contenido o traigas tus archivos existentes.
Cuando trabajas localmente, el [servidor de desarrollo de Astro](https://docs.astro.build/es/reference/cli-reference/#astro-dev) te permite previsualizar tu trabajo y actualiza automáticamente tu navegador cuando realizas cambios.

### Formatos de archivo
Dentro del directorio de tu proyecto, ejecuta el siguiente comando para iniciar el servidor de desarrollo:

Starlight admite la creación de contenido en Markdown y MDX. (Puedes agregar compatibilidad con Markdoc instalando la integración experimental de [Astro Markdoc](https://docs.astro.build/es/guides/integrations-guide/markdoc/).)
<Tabs>
<TabItem label="npm">

### Agregar páginas
```sh
npm run dev
```

Agrega nuevas páginas a tu sitio automáticamente creando archivos `.md` o `.mdx` en `src/content/docs/`. Agrega subcarpetas para organizar tus archivos y crear segmentos de ruta múltiples.
</TabItem>
<TabItem label="pnpm">

```sh
pnpm dev
```
src/content/docs/hello-world.md => tu-sitio.com/hello-world
src/content/docs/guides/faq.md => tu-sitio.com/guides/faq

</TabItem>
<TabItem label="Yarn">

```sh
yarn dev
```

### Frontmatter con seguridad de tipos
</TabItem>
</Tabs>

Esto imprimirá un mensaje en tu terminal con la URL de la vista previa local.
Abre esta URL para comenzar a navegar por tu sitio.

### Añade contenido

Starlight está listo para que añadas nuevo contenido o ¡traigas tus archivos existentes!.

#### Formatos de archivo

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:

Expand All @@ -75,16 +120,18 @@ description: Esta es una página en mi sitio impulsado por Starlight

Si olvidas algo importante, Starlight te lo hará saber.

## Desplegando tu sitio web de Starlight
### Siguientes pasos

Una vez que hayas creado y personalizado tu sitio web de Starlight, puedes implementarlo en un servidor web o plataforma de alojamiento de tu elección, incluyendo Netlify, Vercel, GitHub Pages y muchos más.

[Aprende sobre cómo desplegar un sitio Astro en la documentación de Astro.](https://docs.astro.build/es/guides/deploy/)
- **Configura:** Aprende acerca de las opciones comunes en [“Personalizando Starlight”](/es/guides/customization/).
- **Navega:** Configura tu barra lateral siguiendo la guía [“Barra Lateral de Navegación”](/es/guides/sidebar/).
- **Componentes:** Descubre tarjetas incorporadas, pestañas y más en la guía [“Componentes”](/es/guides/components/).
- **Despliega:** Publica tu trabajo siguiendo la guía [“Despliega tu sitio”](https://docs.astro.build/es/guides/deploy/) en la documentación de Astro.

## Actualizando Starlight

:::tip
Debido a que Starlight es un software beta, habrá actualizaciones y mejoras frecuentes. ¡Asegúrate de actualizar Starlight regularmente!
Debido a que Starlight es un software beta, habrá actualizaciones y mejoras frecuentes.
¡Asegúrate de actualizar Starlight regularmente!
:::

Starlight es una integración Astro y se actualiza de la misma manera que cualquier otra integración `@astrojs/*`:
Expand All @@ -93,37 +140,34 @@ Starlight es una integración Astro y se actualiza de la misma manera que cualqu
<TabItem label="npm">

```sh
# actualizar Starlight con npm
npm install @astrojs/starlight@latest
```

</TabItem>
<TabItem label="pnpm">

```sh
# actualizar Starlight con pnpm
pnpm upgrade @astrojs/starlight --latest
```

</TabItem>
<TabItem label="Yarn">

```sh
# actualizar Starlight con yarn
yarn upgrade @astrojs/starlight --latest
```

</TabItem>
</Tabs>

Puedes ver una lista completa de los cambios realizados en cada versión en [el registro de cambios de Starlight](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md).
Consulta el [registro de cambios de Starlight](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md) para obtener una lista completa de los cambios realizados en cada versión.

## Solución de problemas de Starlight

Tanto la [configuración del proyecto](/es/reference/configuration/) como la [configuración individual de frontmatter](/es/reference/frontmatter/) de cada página están disponibles en la sección de Referencia de este sitio. Utiliza estas páginas para asegurarte de que tu sitio Starlight está configurado y funcionando correctamente.

Revisa la creciente lista de guías en la barra lateral para obtener ayuda para agregar contenido y personalizar tu sitio Starlight.
Utiliza las páginas de referencia de [configuración del proyecto](/es/reference/configuration/) y [configuración del frontmatter de páginas individuales](/es/reference/frontmatter/) para asegurarte de que tu sitio de Starlight esté configurado y funcione correctamente.
Consulta las guías en la barra lateral para obtener ayuda en la adición de contenido y personalización de tu sitio de Starlight.

Si no encuentras la respuesta en la documentación, visita la [documentación completa de Astro](https://docs.astro.build) para obtener la documentación completa de Astro. Es posible que tu pregunta se responda comprendiendo cómo funciona Astro en general, debajo de este tema Starlight.
Si no encuentras la respuesta en la documentación, visita la [documentación completa de Astro](https://docs.astro.build/es/) para obtener la documentación completa de Astro.
Es posible que tu pregunta se responda comprendiendo cómo funciona Astro en general, debajo de este tema Starlight.

También puedes revisar cualquier problema conocido de [Starlight en GitHub](https://github.com/withastro/starlight/issues) y obtener ayuda en el [Discord de Astro](https://astro.build/chat/) de nuestra activa y amigable comunidad. ¡Publica preguntas en nuestro foro `#support` con la etiqueta "starlight" o visita nuestro canal dedicado `#starlight` para discutir el desarrollo actual y más!
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 @@ -146,7 +146,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](/guides/i18n)
- [Soporte de i18n](/es/guides/i18n)

:::

Expand All @@ -160,7 +160,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](/guides/i18n)
- [Soporte de i18n](/es/guides/i18n)

:::
```
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/es/guides/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ import IconsList from '../../../../components/icons-list.astro';

Starlight proporciona un conjunto de iconos comunes que puedes mostrar en tu contenido utilizando el componente `<Icon>`.

Cada `<Icon>` requiere un atributo `name` que se puede encontrar en la lista de [todos los iconos](#all-icons), y opcionalmente puede incluir atributos como `label`, `size` y `color`.
Cada `<Icon>` requiere un atributo `name` que se puede encontrar en la lista de [todos los iconos](#todos-los-iconos), y opcionalmente puede incluir atributos como `label`, `size` y `color`.

```mdx
import { Icon } from '@astrojs/starlight/components';
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/es/guides/customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ Proporciona módulos npm que puedes instalar para las fuentes que deseas utiliza

### Usar fuentes

Para aplicar la fuente que configuraste a tu sitio, utiliza el nombre de la fuente elegida en un [archivo CSS personalizado](/es/guides/css-and-tailwind/#custom-css-styles).
Para aplicar la fuente que configuraste a tu sitio, utiliza el nombre de la fuente elegida en un [archivo CSS personalizado](/es/guides/css-and-tailwind/#estilos-css-personalizados).
Por ejemplo, para anular la fuente predeterminada de Starlight en todas partes, establece la propiedad personalizada `--sl-font`:

```css
Expand All @@ -418,4 +418,4 @@ main {
}
```

Sigue las [instrucciones de CSS personalizado](/guides/css-and-tailwind/#estilos-css-personalizados) para agregar tus estilos a tu sitio.
Sigue las [instrucciones de CSS personalizado](/es/guides/css-and-tailwind/#estilos-css-personalizados) para agregar tus estilos a tu sitio.
6 changes: 5 additions & 1 deletion docs/src/content/docs/es/guides/i18n.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,11 @@ Si no hay una traducción disponible para un idioma, Starlight mostrará a los l

## Traduce la UI de Starlight

Starlight proporciona de forma predeterminada traducciones para los textos utilizados en la UI al inglés, checo, francés, alemán, italiano, japonés, holandés, portugués, danés, español, turco, árabe, noruego, farsi, hebreo, chino simplificado, coreano, indonesio, ruso, sueco, ucraniano y vietnamita. También damos la bienvenida a [contribuciones para agregar más idiomas predeterminados](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md).
Además de alojar archivos de contenido traducidos, Starlight te permite traducir las etiquetas de UI predeterminadas (p. ej. el encabezado "En esta página" en la tabla de contenidos) para que tus lectores puedan experimentar tu sitio completamente en el idioma seleccionado.

Inglés, checo, francés, alemán, italiano, japonés, portugués, holandés, danés, español, turco, árabe, noruego, farsi, hebreo, chino simplificado, coreano, indonesio, ruso, sueco, ucraniano, vietnamita y gallego se proporcionan de forma predeterminada, y damos la bienvenida a [contribuciones para agregar más idiomas predeterminados](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md).

Puedes proprocionar traducciones para idiomas adicionales, o editar nuestras etiquetas predeterminadas, a través de la colección de datos `i18n`.

1. Configura la colección de datos `i18n` en `src/content/config.ts` si aún no está configurada:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/es/guides/project-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Los proyectos de Starlight generalmente siguen la misma estructura de archivos y
- `astro.config.mjs` — El archivo de configuración de Astro; incluye la integración y configuración de Starlight.
- `src/content/config.ts` — El archivo de configuración de las colecciones de contenido; añade los esquemas del frontmatter de Starlight a tu proyecto.
- `src/content/docs/` — Archivos de contenido. Starlight convierte cada archivo `.md`, `.mdx` o `.mdoc` en este directorio en una página de tu sitio.
- `src/content/i18n/` (opcional) — Datos de traducción para soportar la [internacionalización](/guides/i18n/).
- `src/content/i18n/` (opcional) — Datos de traducción para soportar la [internacionalización](/es/guides/i18n/).
- `src/` — Otros códigos fuente y archivos (componentes, estilos, imágenes, etc.) para tu proyecto.
- `public/` — Recursos estáticos (fuentes, favicon, PDF, etc.) que no serán procesados por Astro.

Expand Down
26 changes: 25 additions & 1 deletion docs/src/content/docs/es/guides/sidebar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ La configuración `sidebar` del frontmatter solo se usa para enlaces autogenerad

## Insignias

Los enlaces también pueden incluir una propiedad `badge` para mostrar una insignia junto a la etiqueta del enlace.
Los enlaces, grupos y grupos autogenerados también pueden incluir una propiedad `badge` para mostrar una insignia junto a la etiqueta del enlace.

```js
starlight({
Expand All @@ -257,6 +257,12 @@ starlight({
},
],
},
// An autogenerated group with a "Deprecated" badge.
{
label: 'Referencia',
badge: 'Obsoleto',
autogenerate: { directory: 'reference' },
},
],
});
```
Expand All @@ -275,6 +281,24 @@ La configuración anterior genera la siguiente barra lateral:
},
],
},
{
label: 'Referencia',
badge: { text: 'Obsoleto', variant: 'default' },
items: [
{
label: 'Referencia de Configuración',
link: '/reference/configuration/',
},
{
label: 'Referencia de Frontmatter',
link: '/reference/frontmatter/',
},
{
label: 'Referencia de Personalización de Componentes',
link: '/reference/overrides/',
},
],
},
]}
/>

Expand Down
Loading

0 comments on commit d546667

Please sign in to comment.