diff options
author | Waxer59 | 2023-07-03 16:06:59 +0200 |
---|---|---|
committer | GitHub | 2023-07-03 16:06:59 +0200 |
commit | 51dd8a9194901c4016a6c49e2a867287c4d57f01 (patch) | |
tree | 606a7f29fede986c2b532a9785a7366bf58ccd26 | |
parent | dffca461633940847e9177913053885c5e8b5f29 (diff) | |
download | IT.starlight-51dd8a9194901c4016a6c49e2a867287c4d57f01.tar.gz IT.starlight-51dd8a9194901c4016a6c49e2a867287c4d57f01.tar.bz2 IT.starlight-51dd8a9194901c4016a6c49e2a867287c4d57f01.zip |
i18n(es): frontmatter.md, components.mdx & configuration.md (#287)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
-rw-r--r-- | docs/src/content/docs/es/guides/components.mdx | 27 | ||||
-rw-r--r-- | docs/src/content/docs/es/reference/configuration.md | 74 | ||||
-rw-r--r-- | docs/src/content/docs/es/reference/frontmatter.md | 13 |
3 files changed, 111 insertions, 3 deletions
diff --git a/docs/src/content/docs/es/guides/components.mdx b/docs/src/content/docs/es/guides/components.mdx index e4fe4270..10f06252 100644 --- a/docs/src/content/docs/es/guides/components.mdx +++ b/docs/src/content/docs/es/guides/components.mdx @@ -61,7 +61,7 @@ import { Card, CardGrid } from '@astrojs/starlight/components'; Puedes mostrar contenido en una caja que coincida con los estilos de Starlight utilizando el componente `<Card>`. Envuelve varias tarjetas en el componente `<CardGrid>` para mostrar las tarjetas una al lado de la otra cuando hay suficiente espacio. -El componente `<Card>` requiere un `title` y opcionalmente puede incluir un atributo `icon` establecido con el nombre de [uno de los iconos integrados de Starlight](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Icons.ts). +El componente `<Card>` requiere un `title` y opcionalmente puede incluir un atributo `icon` establecido con el nombre de [uno de los iconos integrados de Starlight](#todos-los-iconos). ```mdx import { Card, CardGrid } from '@astrojs/starlight/components'; @@ -101,3 +101,28 @@ Utiliza una cuadrícula de tarjetas en tu página de inicio para mostrar las car ``` ::: + +### Iconos + +import { Icon } from '@astrojs/starlight/components'; +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`. + +```mdx +import { Icon } from '@astrojs/starlight/components'; + +<Icon name="star" color="goldenrod" size="2rem" /> +``` + +El código anterior genera lo siguiente en la página: + +<Icon name="star" color="goldenrod" size="2rem" /> + +#### Todos los iconos + +A continuación se muestra una lista de todos los iconos disponibles con sus nombres asociados. + +<IconsList />
\ No newline at end of file diff --git a/docs/src/content/docs/es/reference/configuration.md b/docs/src/content/docs/es/reference/configuration.md index 36a94961..6b5b79e5 100644 --- a/docs/src/content/docs/es/reference/configuration.md +++ b/docs/src/content/docs/es/reference/configuration.md @@ -119,6 +119,64 @@ starlight({ }); ``` +#### Ordenación + +Los grupos de la barra lateral generados automáticamente se ordenan alfabéticamente por el nombre del archivo. +Por ejemplo, una página generada a partir de `astro.md` aparecería por encima de la página `starlight.md`. + +#### Colapsando grupos + +Los grupos de enlaces se expanden de forma predeterminada. Puedes cambiar este comportamiento estableciendo la propiedad `collapsed` de un grupo como `true`. + +Los subgrupos generados automáticamente respetan por defecto la propiedad `collapsed` de su grupo padre. Puedes establecer la propiedad `autogenerate.collapsed` para anular esto. + +```js +sidebar: [ + // Un grupo colapsado de enlaces. + { + label: 'Collapsed Links', + collapsed: true, + items: [ + { label: 'Introduction', link: '/intro' }, + { label: 'Next Steps', link: '/next-steps' }, + ], + }, + // Un grupo expandido que contiene subgrupos generados automáticamente colapsados. + { + label: 'Reference', + autogenerate: { + directory: 'reference', + collapsed: true, + }, + }, +], +``` + +#### Traduciendo etiquetas + +Si tu sitio es multilingüe, se considera que la etiqueta de cada elemento está en el idioma predeterminado. Puedes establecer una propiedad de `translations` para proporcionar etiquetas en los otros idiomas que tu sitio admita: +```js +sidebar: [ + // Un ejemplo de barra lateral con etiquetas traducidas al francés. + { + label: 'Start Here', + translations: { fr: 'Commencez ici' }, + items: [ + { + label: 'Getting Started', + translations: { fr: 'Bien démarrer' }, + link: '/getting-started', + }, + { + label: 'Project Structure', + translations: { fr: 'Structure du projet' }, + link: '/structure', + }, + ], + }, +], +``` + #### `SidebarItem` ```ts @@ -127,8 +185,11 @@ type SidebarItem = { translations?: Record<string, string>; } & ( | { link: string } - | { items: SidebarItem[] } - | { autogenerate: { directory: string } } + | { items: SidebarItem[]; collapsed?: boolean } + | { + autogenerate: { directory: string; collapsed?: boolean }; + collapsed?: boolean; + } ); ``` @@ -289,3 +350,12 @@ interface HeadConfig { content?: string; } ``` + +### `lastUpdated` + +**type:** `boolean` +**default:** `false` + +Controla si se muestra el pie de página que indica cuándo se actualizó por última vez la página. + +De forma predeterminada, esta función se basa en el historial Git de tu repositorio y puede no ser precisa en algunas plataformas de implementación que realizan [copias superficiales](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt). Una página puede anular esta configuración o la fecha basada en Git utilizando el campo [`lastUpdated`](/reference/frontmatter/#lastupdated) en el frontmatter. diff --git a/docs/src/content/docs/es/reference/frontmatter.md b/docs/src/content/docs/es/reference/frontmatter.md index dd801711..39169f00 100644 --- a/docs/src/content/docs/es/reference/frontmatter.md +++ b/docs/src/content/docs/es/reference/frontmatter.md @@ -133,3 +133,16 @@ interface HeroConfig { }>; } ``` + +### `lastUpdated` + +**type:** `Date | boolean` + +Sobrescribe la [opción global `lastUpdated`](/reference/configuration/#lastupdated). Si se especifica una fecha, debe ser una [marca de tiempo YAML](https://yaml.org/type/timestamp.html) válida y sobrescribirá la fecha almacenada en el historial de Git para esta página. + +```md +--- +title: Página con una fecha de última actualización personalizada +lastUpdated: 2022-08-09 +--- +```
\ No newline at end of file |