Skip to content

Commit

Permalink
Merge branch 'main' into hd-virtual-pages
Browse files Browse the repository at this point in the history
* main: (96 commits)
  [ci] format
  i18n(ko-KR): update `manual-setup.mdx` (withastro#1482)
  i18n(ko-KR): update `community-content.mdx` (withastro#1483)
  [ci] format
  [ci] release (withastro#1481)
  [ci] format
  Make Starlight compatible with server output mode (withastro#1454)
  [i18nIgnore] community content: article description copy edit (withastro#1408)
  [ci] format
  i18n(it): Updated plugins.md and community-content.mdx (withastro#1480)
  i18n(fr): update `resources/community-content` (withastro#1479)
  [ci] format
  i18n(it): Modified everything in the /guides folder (withastro#1456)
  i18n(it): Modified frontmatter.md and overrides.md (withastro#1457)
  i18n(es): fix syntax highlighting with `diff`-like syntax example (withastro#1477)
  Add CodingCat.dev stream video to community content page (withastro#1475)
  i18n(fr): fix frontmatter `label` default value translation (withastro#1476)
  [ci] format
  [ci] release (withastro#1474)
  Set default color theme in template (withastro#1473)
  ...
  • Loading branch information
HiDeoo committed Feb 10, 2024
2 parents a887c62 + b5b188c commit 2107f4a
Show file tree
Hide file tree
Showing 107 changed files with 4,362 additions and 1,229 deletions.
6 changes: 5 additions & 1 deletion docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,11 @@ export default defineConfig({
{
label: 'Resources',
badge: 'New',
translations: {},
translations: {
'zh-CN': '资源',
fr: 'Ressources',
'pt-BR': 'Recursos',
},
autogenerate: { directory: 'resources' },
},
],
Expand Down
4 changes: 2 additions & 2 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"@astrojs/starlight": "workspace:*",
"@lunariajs/core": "^0.0.25",
"@types/culori": "^2.0.0",
"astro": "^4.2.7",
"astro": "^4.3.4",
"culori": "^3.2.0",
"sharp": "^0.32.5",
"virtual-pages-demo": "workspace:*"
Expand All @@ -30,7 +30,7 @@
"hastscript": "^8.0.0",
"pa11y-ci": "^3.0.1",
"rehype": "^13.0.1",
"starlight-links-validator": "^0.5.1",
"starlight-links-validator": "^0.5.3",
"start-server-and-test": "^2.0.0",
"unist-util-visit": "^5.0.0"
}
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 @@ -79,7 +79,7 @@ starlight({
});
```

Mit dieser Konfiguration würde eine `/einfuehrung` einen Bearbeitungslink haben, der auf `https://github.com/withastro/starlight/edit/main/src/docs/einfuehrung.md` zeigt.
Mit dieser Konfiguration würde eine `/einfuehrung` einen Bearbeitungslink haben, der auf `https://github.com/withastro/starlight/edit/main/src/content/docs/einfuehrung.md` zeigt.

### `sidebar`

Expand Down
6 changes: 3 additions & 3 deletions docs/src/content/docs/es/guides/authoring-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ Algunos de los ejemplos más comunes se muestran a continuación:
function thisIsJavaScript() {
// ¡El bloque completo se resalta como JavaScript,
// y aún podemos añadir marcadores de diferencias a él!
- console.log('Código antiguo a eliminar'')
- console.log('Código antiguo a eliminar')
+ console.log('¡Nuevo y brillante código!')
}
```
Expand All @@ -308,8 +308,8 @@ Algunos de los ejemplos más comunes se muestran a continuación:
function thisIsJavaScript() {
// ¡El bloque completo se resalta como JavaScript,
// y aún podemos añadir marcadores de diferencias a él!
- console.log('Old code to be removed')
+ console.log('New and shiny code!')
- console.log('Código antiguo a eliminar')
+ console.log('¡Nuevo y brillante código!')
}
```
````
Expand Down
46 changes: 46 additions & 0 deletions docs/src/content/docs/es/guides/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,49 @@ El código anterior genera lo siguiente en la página:
A continuación se muestra una lista de todos los iconos disponibles con sus nombres asociados. Haz clic en un ícono para copiar el código del componente correspondiente.

<IconsList />

### Código

Usa el componente `<Code>` para renderizar código con resaltado de sintaxis cuando no sea posible usar un [bloque de código Markdown](/es/guides/authoring-content/#bloques-de-código), por ejemplo, para renderizar datos provenientes de fuentes externas como archivos, bases de datos o APIs.

Consulta el [componente de código de Expressive Code](https://expressive-code.com/key-features/code-component/) para obtener detalles completos de las props que admite `<Code>`.

```mdx
# src/content/docs/example.mdx

import { Code } from '@astrojs/starlight/components';

export const exampleCode = `console.log('¡Esto podría venir de un archivo o CMS!');`;
export const fileName = 'example.js';
export const highlights = ['file', 'CMS'];

<Code code={exampleCode} lang="js" title={fileName} mark={highlights} />
```

El código anterior genera lo siguiente en la página:

import { Code } from '@astrojs/starlight/components';

export const exampleCode = `console.log('¡Esto podría venir de un archivo o CMS!');`;
export const fileName = 'example.js';
export const highlights = ['file', 'CMS'];

<Code code={exampleCode} lang="js" title={fileName} mark={highlights} />

#### Código importado

Usa [el sufijo de importación `?raw` de Vite](https://vitejs.dev/guide/assets#importing-asset-as-string) para importar cualquier archivo de código como un string.
Puedes pasar luego este string importado al componente `<Code>` para incluirlo en tu página.

```mdx title="src/content/docs/example.mdx" "?raw"
import { Code } from '@astrojs/starlight/components';
import importedCode from '/src/env.d.ts?raw';

<Code code={importedCode} lang="ts" title="src/env.d.ts" />
```

El código anterior genera lo siguiente en la página:

import importedCode from '/src/env.d.ts?raw';

<Code code={importedCode} lang="ts" title="src/env.d.ts" />
19 changes: 19 additions & 0 deletions docs/src/content/docs/es/guides/customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,25 @@ hero:
---
```

### Desactivar la página 404 predeterminada

Si tu proyecto requiere un diseño 404 completamente personalizado, puedes crear una ruta `src/pages/404.astro` y establecer la opción de configuración [`disable404Route`](/es/reference/configuration/#disable404route) para desactivar la ruta predeterminada de Starlight:

```js {9}
// astro.config.mjs
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

export default defineConfig({
integrations: [
starlight({
title: 'Docs With Custom 404',
disable404Route: true,
}),
],
});
```

## Fuentes personalizadas

De forma predeterminada, Starlight utiliza fuentes sans-serif disponibles en el dispositivo local del usuario para todo el texto.
Expand Down
3 changes: 2 additions & 1 deletion docs/src/content/docs/es/guides/sidebar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@ La configuración anterior genera la siguiente barra lateral:

Starlight puede generar automáticamente un grupo en tu barra lateral basado en un directorio de tu documentación.
Esto es útil cuando no deseas ingresar manualmente cada elemento de la barra lateral en un grupo.
Las páginas serán ordenadas alfabéticamente por nombre de archivo de forma predeterminada.

Por defecto, las páginas se ordenan en orden alfabético según el [`slug`](/es/reference/overrides/#slug) del archivo.

Agrega un grupo autogenerado usando un objeto con las propiedades `label` y `autogenerate`. Tu configuración `autogenerate` debe especificar el `directory` para usar en las entradas de la barra lateral. Por ejemplo, con la siguiente configuración:

Expand Down
2 changes: 0 additions & 2 deletions docs/src/content/docs/es/guides/site-search.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Búsqueda en el sitio
description: Aprende sobre las funciones de búsqueda de sitios integradas de Starlight y cómo personalizarlas.
sidebar:
badge: Nuevo
---

import { Tabs, TabItem } from '@astrojs/starlight/components';
Expand Down
9 changes: 8 additions & 1 deletion docs/src/content/docs/es/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ starlight({
});
```

Con esta configuración, una página `/introduction` tendría un enlace de edición que apunta a `https://github.com/withastro/starlight/edit/main/src/docs/introduction.md`.
Con esta configuración, una página `/introduction` tendría un enlace de edición que apunta a `https://github.com/withastro/starlight/edit/main/src/content/docs/introduction.md`.

### `sidebar`

Expand Down Expand Up @@ -514,6 +514,13 @@ Establece un delimitador entre el título de la página y el título del sitio w
Por defecto, cada página tiene un `<title>` de `Título de la página | Título del sitio web`.
Por ejemplo, esta página es titulada "Referencia de Configuración" y este sitio web es titulado "Starlight", por lo que el `<title>` de esta página es "Referencia de Configuración | Starlight".

### `disable404Route`

**tipo:** `boolean`
**por defecto:** `false`

Deshabilita la inyección de la [página 404](https://docs.astro.build/es/core-concepts/astro-pages/#página-de-error-404-personalizada) predeterminada de Starlight. Para usar una ruta `src/pages/404.astro` personalizada en tu proyecto, establece esta opción en `true`.

### `components`

**tipo:** `Record<string, string>`
Expand Down
121 changes: 121 additions & 0 deletions docs/src/content/docs/es/resources/community-content.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
title: Contenido de la comunidad
description: ¡Descubre guías, artículos y videos producidos por la comunidad para ayudarte a aprender y construir con Starlight!
---

:::tip[¡Agrega el tuyo!]
¿Has producido contenido sobre Starlight?
¡Abre una PR añadiendo un enlace a esta página!
:::

import { CardGrid, LinkCard } from '@astrojs/starlight/components';

## Artículos y Reseñas

Aquí tienes una colección de publicaciones y artículos para aprender más sobre Starlight y las experiencias de otras personas:

<CardGrid>
<LinkCard
href="https://devm.io/open-source/starlight-astro"
title="Generación de sitios estáticos con Starlight"
description="“Ninguna idea es demasiado grande o demasiado pequeña al diseñar componentes” — una entrevista con Chris Swithinbank, líder de Starlight"
/>
<LinkCard
href="https://frontendatscale.com/blog/hybrid-frontend-architecture/"
title="Arquitectura híbrida de frontend con Astro y Starlight."
description="Maxi Ferreira y Ben Holmes construyen un sitio de documentación con Starlight, TinaCMS, y un Playground de API interactivo con autenticación."
/>
<LinkCard
href="https://www.olets.dev/posts/comparing-docs-site-builders-vuepress-vs-starlight/"
title="Comparando constructores de sitios de documentación: VuePress vs. Starlight"
description="¿Cómo se comparan los dos frameworks?"
/>
</CardGrid>

## Recetas y Guías

Las Recetas suelen ser cortas, centradas en guiar al lector a través de la realización de un ejemplo práctico de una tarea específica. ¡Las Recetas son una forma estupenda de añadir nuevas características o comportamientos a tu proyecto de Starlight siguiendo las instrucciones paso a paso! Otras guías pueden explicar conceptos relacionados con un área de contenido específica, como el uso de imágenes o trabajar con MDX.

Explora contenido producido por la comunidad mantenido por usuarios de Starlight:

<CardGrid>
<LinkCard
href="https://www.webpro.nl/scraps/versioned-docs-with-starlight-and-vercel"
title="Documentación versionada con Starlight y Vercel"
description="Una guía para implementar versiones separadas de la documentación para cada versión principal de un proyecto."
/>
<LinkCard
href="https://hideoo.dev/notes/starlight-heading-links"
title="Agrega enlaces a los encabezados de Starlight"
description="Una guía sobre cómo usar el plugin de rehype para compartir enlaces en secciones específicas de tu documentación"
/>
<LinkCard
href="https://blog.otterlord.dev/posts/starlight-sponsors/"
title="Agrega patrocinadores a tu sitio de Starlight"
description="Una guía para implementar un componente personalizado de patrocinadores en la barra lateral de tu documentación"
/>
<LinkCard
href="https://hideoo.dev/notes/starlight-og-images"
title="Agrega imágenes Open Graph a Starlight"
description="Una guía para generar imágenes sociales y las etiquetas meta correspondientes para tus páginas"
/>
<LinkCard
href="https://hideoo.dev/notes/starlight-third-party-icon-sets"
title="Utiliza conjuntos de iconos de terceros en Starlight"
description="Una guía para usar unplugin-icons para ampliar la selección de los iconos disponibles para Starlight"
/>
<LinkCard
href="https://hideoo.dev/notes/starlight-custom-html-head"
title="Edita las sección head del HTML para las páginas de Starlight"
description="Aprende como agregar contenido común en la sección head como analíticas web, fuentes y scripts"
/>
<LinkCard
href="https://dev.to/mrrobot/publishing-documentation-with-astro-starlight-691"
title="Publicación de documentación con Astro Starlight"
description="Comenzando con la documentación de Starlight."
/>

</CardGrid>

## Contenido en Video

Descubre videos y canales con contenido de Starlight, incluyendo transmisiones en vivo y contenido educativo.

import YouTubeGrid from '~/components/youtube-grid.astro';

### Videos de Astro

<YouTubeGrid
videos={[
{
href: 'https://www.youtube.com/watch?v=5u0Ds7wzUeI',
title: 'Starlight por Astro',
description: 'Mira el video oficial del lanzamiento de Starlight',
},
{
href: 'https://www.youtube.com/shorts/zjOWezSzd18',
title: '🌟 MENOS DE 1 MINUTO',
description:
'¡Mira como Ben crea un nuevo sitio de Starlight en menos de un minuto!',
},
]}
/>

### Videos de la Comunidad y Transmisiones

<YouTubeGrid
videos={[
{
href: 'https://www.youtube.com/watch?v=sWkkHbwDeQc',
title: 'Astro Starlight',
description: 'Introducción a Starlight en menos de un minuto.',
},
{
href: 'https://www.youtube.com/watch?v=-Ki-1E5gNCk',
title:
'Plantilla de documentación de Astro Starlight (¡construye documentación personalizada para tu aplicación!)',
description:
'Pon en marcha un nuevo sitio de Starlight en unos 5 minutos',
},
]}
/>
75 changes: 75 additions & 0 deletions docs/src/content/docs/es/resources/plugins.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Plugins e Integraciones
description: ¡Descubre herramientas de la comunidad como plugins e integraciones que amplían Starlight!
sidebar:
order: 1
---

:::tip[¡Agrega el tuyo!]
¿Has construido un plugin o herramienta para Starlight?
¡Abre una PR añadiendo un enlace a esta página!
:::

## Plugins

Los [Plugins](/es/reference/plugins/) pueden personalizar la configuración, UI y comportamiento de Starlight, a la vez que son fáciles de compartir y reutilizar.
Amplia tu sitio con un plugins oficiales respaldados por el equipo de Starlight y plugins de la comunidad mantenidos por usuario de Starlight.

### Plugins oficiales

<CardGrid>
<LinkCard
href="/es/guides/site-search/#algolia-docsearch"
title="Algolia DocSearch"
description="Reemplaza Pagefind, el proveedor de búsqueda por defecto, por Algolia DocSearch."
/>
</CardGrid>

### Plugins de la comunidad

<CardGrid>
<LinkCard
href="https://github.com/HiDeoo/starlight-links-validator"
title="starlight-links-validator"
description="Comprueba si hay enlaces rotos en tus páginas de Starlight."
/>
<LinkCard
href="https://github.com/HiDeoo/starlight-typedoc"
title="starlight-typedoc"
description="Genera páginas de Starlight desde TypeScript usando TypeDoc"
/>
</CardGrid>

## Herramientas e integraciones de la comunidad

import { CardGrid, LinkCard } from '@astrojs/starlight/components';

Estas herramientas e integraciones de la comunidad se pueden utilizar para añadir características a tu sitio de Starlight.

<CardGrid>
<LinkCard
href="https://www.feelback.dev/blog/new-astro-starlight-integration/"
title="FeelBack"
description="Agrega un sistema de comentarios de usuarios a la páginas de tus docs."
/>
<LinkCard
href="https://github.com/HiDeoo/starlight-blog"
title="starlight-blog"
description="Agrega un blog a tu sitio de documentación."
/>
<LinkCard
href="https://github.com/HiDeoo/starlight-openapi"
title="starlight-openapi"
description="Crea páginas de documentación a partir de especificaciones OpenAPI/Swagger."
/>
<LinkCard
href="https://github.com/val-town/notion-to-astro"
title="notion-to-astro"
description="Convierte las exportaciones de Notion a docs de Astro Starlight."
/>
<LinkCard
href="https://github.com/mattjennings/astro-live-code"
title="astro-live-code"
description="Renderiza bloques de código MDX como componentes interactivos."
/>
</CardGrid>
21 changes: 21 additions & 0 deletions docs/src/content/docs/es/resources/showcase.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Exhibición de Starlight
description: ¡Descubre sitios construidos con Starlight!
sidebar:
label: Galería de sitios
---

:::tip[¡Agrega el tuyo!]
¿Has construido un sitio de Starlight o una herramienta para Starlight?
¡Abre una PR agregando un enlace a esta página!
:::

## Sitios

import ShowcaseSites from '~/components/showcase-sites.astro';

Starlight ya está siendo usado en producción. Estos son algunos de los sitios en la web:

<ShowcaseSites />

Mira todos los [repositorios públicos de proyectos usando Starlight en GitHub](https://github.com/withastro/starlight/network/dependents).
Loading

0 comments on commit 2107f4a

Please sign in to comment.