Skip to content

Commit

Permalink
Merge branch 'main' into fix/issue-2715
Browse files Browse the repository at this point in the history
  • Loading branch information
delucis authored Jan 10, 2025
2 parents 3ff3855 + 656ed7d commit f7e0d6a
Show file tree
Hide file tree
Showing 46 changed files with 356 additions and 196 deletions.
5 changes: 0 additions & 5 deletions .changeset/proud-apricots-warn.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/rude-lobsters-destroy.md

This file was deleted.

5 changes: 5 additions & 0 deletions .changeset/smart-moons-repair.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/starlight': patch
---

Prevents the header title from being translated by automatic translation systems.
4 changes: 2 additions & 2 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"build": "astro build",
"preview": "astro preview",
"typecheck": "tsc --noEmit",
"linkcheck": "CHECK_LINKS=true pnpm build --force",
"linkcheck": "CHECK_LINKS=true pnpm build",
"astro": "astro",
"lunaria:build": "lunaria build",
"grammars": "node grammars/generate.mjs"
Expand All @@ -28,6 +28,6 @@
"@playwright/test": "^1.45.0",
"axe-playwright": "^2.0.3",
"sitemapper": "^3.2.12",
"starlight-links-validator": "^0.13.2"
"starlight-links-validator": "^0.14.0"
}
}
2 changes: 1 addition & 1 deletion docs/src/content/docs/components/using-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The following example uses `ComponentProps` to get the type of the props accepte
---
// src/components/Example.astro
import type { ComponentProps } from 'astro/types';
import { Icon } from '@astrojs/starlight/icon';
import { Icon } from '@astrojs/starlight/components';
type IconProps = ComponentProps<typeof Icon>;
---
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/de/components/using-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Das folgende Beispiel benutzt `ComponentProps`, um den Typ der Eigenschaften zu
---
// src/components/Example.astro
import type { ComponentProps } from 'astro/types';
import { Icon } from '@astrojs/starlight/icon';
import { Icon } from '@astrojs/starlight/components';
type IconProps = ComponentProps<typeof Icon>;
---
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/fr/components/using-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ L'exemple suivant utilise `ComponentProps` pour obtenir le type des props accept
---
// src/components/Exemple.astro
import type { ComponentProps } from 'astro/types';
import { Icon } from '@astrojs/starlight/icon';
import { Icon } from '@astrojs/starlight/components';
type IconProps = ComponentProps<typeof Icon>;
---
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/ko/components/using-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Starlight는 요소 사이에 여백을 추가하는 등 Markdown 콘텐츠에
---
// src/components/Example.astro
import type { ComponentProps } from 'astro/types';
import { Icon } from '@astrojs/starlight/icon';
import { Icon } from '@astrojs/starlight/components';
type IconProps = ComponentProps<typeof Icon>;
---
Expand Down
32 changes: 17 additions & 15 deletions docs/src/content/docs/pt-pt/environmental-impact.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,20 +89,21 @@ Escolher um alojamento que utiliza energia renovável significará menos emissõ
Está curioso para comparar com os outros frameworks de documentação?
Estes testes realizados com o [Website Carbon Calculator][wcc] comparam páginas semelhantes construídas com diferentes ferramentas.

| Framework | CO₂ por visita da página |
| --------------------------- | ------------------------ |
| [Starlight][sl-carbon] | 0.01g |
| [VitePress][vp-carbon] | 0.05g |
| [Docus][dc-carbon] | 0.05g |
| [Sphinx][sx-carbon] | 0.07g |
| [MkDocs][mk-carbon] | 0.10g |
| [Nextra][nx-carbon] | 0.11g |
| [docsify][dy-carbon] | 0.11g |
| [Docusaurus][ds-carbon] | 0.24g |
| [Read the Docs][rtd-carbon] | 0.24g |
| [GitBook][gb-carbon] | 0.71g |

<small>Dados recolhidos a 14 de Maio de 2023. Clique num dos links para ver os valores atualizados.</small>
| Framework | CO₂ per page visit | Rating |
| --------------------------- | ------------------ | :----: |
| [Starlight][sl-carbon] | 0.01g | A+ |
| [Read the Docs][rtd-carbon] | 0.05g | A+ |
| [Sphinx][sx-carbon] | 0.06g | A+ |
| [VitePress][vp-carbon] | 0.07g | A+ |
| [Docus][dc-carbon] | 0.09g | A+ |
| [docsify][dy-carbon] | 0.10g | A |
| [Nextra][nx-carbon] | 0.11g | A |
| [MkDocs][mk-carbon] | 0.19g | B |
| [Docusaurus][ds-carbon] | 0.21g | B |
| [GitBook][gb-carbon] | 0.43g | C |
| [Mintlify][mt-carbon] | 1.22g | F |

<small>Dados recolhidos a 22 de Julho de 2024. Clique num dos links para ver os valores atualizados.</small>

[sl-carbon]: https://www.websitecarbon.com/website/starlight-astro-build-getting-started/
[vp-carbon]: https://www.websitecarbon.com/website/vitepress-dev-guide-what-is-vitepress/
Expand All @@ -114,6 +115,7 @@ Estes testes realizados com o [Website Carbon Calculator][wcc] comparam páginas
[ds-carbon]: https://www.websitecarbon.com/website/docusaurus-io-docs/
[rtd-carbon]: https://www.websitecarbon.com/website/docs-readthedocs-io-en-stable-index-html/
[gb-carbon]: https://www.websitecarbon.com/website/docs-gitbook-com/
[mt-carbon]: https://www.websitecarbon.com/website/mintlify-com-docs-quickstart/

## Mais recursos

Expand All @@ -135,6 +137,6 @@ Estes testes realizados com o [Website Carbon Calculator][wcc] comparam páginas
[sf]: https://www.sciencefocus.com/science/what-is-the-carbon-footprint-of-the-internet/
[bbc]: https://www.bbc.com/future/article/20200305-why-your-internet-habits-are-not-as-clean-as-you-think
[http]: https://httparchive.org/reports/state-of-the-web
[assets]: https://docs.astro.build/pt-pt/guides/assets/
[assets]: https://docs.astro.build/en/guides/images/
[islands]: https://docs.astro.build/pt-pt/concepts/islands/
[wcc]: https://www.websitecarbon.com/
6 changes: 6 additions & 0 deletions docs/src/content/docs/pt-pt/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: Starlight ajuda-te a construir websites de documentação belos e r
template: splash
editUrl: false
lastUpdated: false
banner:
content: |
Atualização para o Astro 5?
<a href="https://github.com/withastro/starlight/releases/tag/%40astrojs/starlight%400.30.0">
Aprenda como fazer
</a>
hero:
title: Faça a sua documentação brilhar com Starlight
tagline: Tudo o que precisa para construir um site de documentação brilhante. Rápido, acessível e fácil de usar.
Expand Down
26 changes: 16 additions & 10 deletions docs/src/content/docs/pt-pt/manual-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Para seguir este guia, você vai precisar de um projeto Astro existente.

O Starlight é uma [integração Astro](https://docs.astro.build/pt-br/guides/integrations-guide/). Adicione-o ao seu site executando o comando `astro add` no diretório raiz do seu projeto:

<Tabs>
<Tabs syncKey="pkg">
<TabItem label="npm">```sh npx astro add starlight ```</TabItem>
<TabItem label="pnpm">```sh pnpm astro add starlight ```</TabItem>
<TabItem label="Yarn">```sh yarn astro add starlight ```</TabItem>
Expand Down Expand Up @@ -48,20 +48,25 @@ Encontre todas as opções disponíveis na referência sobre [configuração do

### Configure coleções de conteúdos

O Starlight é construído com base nas [coleções de conteúdos](https://docs.astro.build/pt-pt/guides/content-collections/) do Astro, que são configuradas no arquivo `src/content/config.ts`.
O Starlight é construído com base nas [coleções de conteúdos](https://docs.astro.build/pt-pt/guides/content-collections/) do Astro, que são configuradas no arquivo `src/content.config.ts`.

Crie ou atualize o arquivo de configuração de conteúdo, adicionando uma coleção `docs` que usa o esquema `docsSchema` do Starlight:
Crie ou atualize o arquivo de configuração de conteúdo, adicionando uma coleção `docs` que usa os esquemas `docsLoader` e `docsSchema` do Starlight:

```js ins={3,6}
```js ins={3-4,7}
// src/content/config.ts
import { defineCollection } from 'astro:content';
import { docsLoader } from '@astrojs/starlight/loaders';
import { docsSchema } from '@astrojs/starlight/schema';

export const collections = {
docs: defineCollection({ schema: docsSchema() }),
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
};
```

O Starlight tambem suporta a [opção `legacy.collections`](https://docs.astro.build/pt-pt/reference/legacy-flags/) onde as coleções são tratadas utilizando a implementação
anterior das coleções de conteúdo.
Isto é útil se tiver um projeto Astro existente e não pode, de momento, efetuar alterações às coleções para utilizar um `loader`.

### Adicione conteúdo

Agora que o Starlight está configurado é hora de adicionar algum conteúdo!
Expand All @@ -84,11 +89,11 @@ Veja todas as opções disponíveis na [referência do frontmatter](/pt-pt/refer

## Dicas para sites existentes

Se você tiver um projeto Astro existente, pode utilizar o Starlight para adicionar rapidamente uma seção de documentação ao seu site.
Se você tiver um projeto Astro existente, pode utilizar o Starlight para adicionar rapidamente uma secção de documentação ao seu site.

### Utilize o Starlight como um subcaminho
### Utilize o Starlight como um sub-caminho

Para adicionar todas as páginas do Starlight num subcaminho, coloque todo o conteúdo da sua documentação dentro de um subdiretório de `src/content/docs/`.
Para adicionar todas as páginas do Starlight num sub-caminho, coloque todo o conteúdo da sua documentação dentro de um sub-diretório de `src/content/docs/`.

Por exemplo, se todas as páginas do Starlight devem começar com `/guias/`, adicione o seu conteúdo no diretório `src/content/docs/guias/`:

Expand All @@ -111,7 +116,8 @@ No futuro, planeamos melhorar o suporte deste caso de uso para evitar a necessid

### Usar o Starlight com SSR

Pode utilizar o Starlight no seu projeto juntamente com outros conjuntos de páginas renderizadas a pedido seguindo para isso o guia [“Adaptadores de renderização a pedido”](https://docs.astro.build/en/guides/server-side-rendering/) da documentação do Astro.
Para habilitar o SSR siga o guia [“Adaptadores de renderização a pedido”](https://docs.astro.build/en/guides/on-demand-rendering/) da documentação do Astro e
adicione um adaptador ao seu projeto Starlight.

Atualmente as páginas de documentação geradas pelo Starlight são sempre pré-renderizadas independentemente do modo de geração do projeto.
Esperamos ser capazes de suportar a renderização a pedido de páginas do Startlight dentro em breve.
Para desabilitar a pré-renderização das suas páginas Starlight coloque a [opção de config `prerender`](/pt-pt/reference/configuration/#prerender) a `false`.
11 changes: 11 additions & 0 deletions docs/src/content/docs/pt-pt/resources/community-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ Explore o conteúdo produzido pela comunidade e mantido pelos utilizadores Starl
title="Acrescentar Dados Estructurados a páginas do Starlight"
description="Aprenda a construir dados dinâmicos estructurados JSON-LD para as suas páginas de documentação."
/>
<LinkCard
href="https://starlight-examples.netlify.app/"
title="Exemplos do Starlight"
description="Uma coleção de exemplos deStackBlitz embebidos que demonstram formas práticas de fazer coisas em sites de documentação do Starlight."
/>
</CardGrid>

## Conteúdo de Vídeo
Expand Down Expand Up @@ -148,5 +153,11 @@ import YouTubeGrid from '~/components/youtube-grid.astro';
description:
'Neste video eu abordo o que torna o Starlight tão porreiro e porque razão deve experimentá-lo no seu próximo projecto.',
},
{
href: 'https://www.youtube.com/watch?v=Q1E4Gkt63ko',
title: 'Astro Starlight and emoji-blast with Chris Swithinbank',
description:
"Wherein Chris, the creator of Astro's Starlight framework-on-a-framework, walks me through setting it up for a new emoji-blast website. 🌟 🎇",
},
]}
/>
78 changes: 75 additions & 3 deletions docs/src/content/docs/pt-pt/resources/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,79 @@ Estenda o seu site com os plugins oficiais suportados pela equipa Starlight e co
title="starlight-image-zoom"
description="Adicione funções de zoom à sua documentação do Starlight."
/>
<LinkCard
<LinkCard
href="https://github.com/lorenzolewis/starlight-utils"
title="starlight-utils"
description="Extenda o Starlight com uma coleção de utilitários comuns."
description="Estenda o Starlight com uma coleção de utilitários comuns."
/>
<LinkCard
href="https://github.com/trueberryless/starlight-view-modes"
title="starlight-view-modes"
description="Adicione a capacidade de mostrar diferentes formas de visualização no seu website de documentação."
/>
<LinkCard
href="https://github.com/HiDeoo/starlight-versions"
title="starlight-versions"
description="Acrescente a versão às páginas da sua documentação Starlight."
/>
<LinkCard
href="https://inox-tools.fryuni.dev/star-warp"
title="star-warp"
description="Acelere a pesquisa de resultados na sua documentação."
/>
<LinkCard
href="https://github.com/HiDeoo/starlight-heading-badges"
title="starlight-heading-badges"
description="Adicione distintivos aos cabeçalhos de Markdown e MDX."
/>
<LinkCard
href="https://github.com/Fevol/starlight-site-graph"
title="starlight-site-graph"
description="Adicione um mapa interativo do site à barra lateral das suas páginas."
/>
<LinkCard
href="https://github.com/HiDeoo/starlight-sidebar-topics"
title="starlight-sidebar-topics"
description="Divida a sua documentação em secções diferentes cada uma com a sua barra lateral."
/>
<LinkCard
href="https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown"
title="starlight-sidebar-topics-dropdown"
description="Divida as suas páginas de documentação em várias sub-páginas e alterne entre elas através de um menu na barra lateral."
/>
<LinkCard
href="https://github.com/trueberryless-org/starlight-cooler-credit"
title="starlight-cooler-credit"
description="Adicione os créditos do Starlight ou Astro no fundo da tabela de conteúdos."
/>
<LinkCard
href="https://github.com/trueberryless-org/starlight-contributor-list"
title="starlight-contributor-list"
description="Apresente uma lista de todos os contribuidores do seu projeto."
/>
</CardGrid>

### Temas da comunidade

Um Tema é um plugin do Starlight que muda visualmente a aparência do site através da sobreposição de componentes, CSS personalizados, ou outras
novas funcionalidades.

<CardGrid>
<LinkCard
href="https://github.com/HiDeoo/starlight-theme-rapide"
title="starlight-theme-rapide"
description="Tema do Starlight inspirado no tema Vitesse do Visual Studio Code."
/>
<LinkCard
href="https://github.com/Fevol/starlight-theme-obsidian"
title="starlight-theme-obsidian"
description="Tema do Starlight inspirado em sites com o tema Obsidian Publish."
/>
<LinkCard
href="https://github.com/TheOtterlord/catppuccin-starlight"
title="catppuccin-starlight"
description="Tema em tons de pastel suave para o Starlight"
/>
</CardGrid>

## Ferramentas e integrações da comunidade
Expand Down Expand Up @@ -106,6 +173,11 @@ Estas ferramentas e integrações da comunidade podem ser usadas para adicionar
<LinkCard
href="https://github.com/HiDeoo/starlight-showcases"
title="starlight-showcases"
description="Conjunto de componentes do Starlight para cosntruir páginas de demonstração."
description="Conjunto de componentes do Starlight para construir páginas de demonstração."
/>
<LinkCard
href="https://github.com/HiDeoo/generator-starlight-plugin"
title="@hideoo/starlight-plugin"
description="A generator to quickly scaffold Starlight plugins."
/>
</CardGrid>
7 changes: 4 additions & 3 deletions docs/src/content/docs/ru/guides/i18n.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ import UIStringsList from '~/components/ui-strings-list.astro';

```diff lang="js" ins=/, (i18nLoader|i18nSchema)/
// src/content.config.ts
import { defineCollection } from 'astro:content';
import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders';
import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';

Expand Down Expand Up @@ -283,15 +284,15 @@ export const collections = {
Вы можете получить доступ к [встроенным строкам пользовательского интерфейса](/ru/guides/i18n/#перевод-интерфейса-starlight) Starlight, а также к [пользовательским](/ru/guides/i18n/#расширение-схемы-перевода) и [предоставляемым плагинами](/ru/reference/plugins/#injecttranslations) строкам пользовательского интерфейса через единый API на базе [i18next](https://www.i18next.com/).
Это включает поддержку таких функций, как [интерполяция](https://www.i18next.com/translation-function/interpolation) и [плюрализация](https://www.i18next.com/translation-function/plurals).

В компонентах Astro этот API доступен как часть [глобального объекта `Astro`](https://docs.astro.build/ru/reference/api-reference/#astrolocals) в виде `Astro.locals.t`:
В компонентах Astro этот API доступен как часть [глобального объекта `Astro`](https://docs.astro.build/en/reference/api-reference/#locals) в виде `Astro.locals.t`:

```astro title="example.astro"
<p dir={Astro.locals.t.dir()}>
{Astro.locals.t('404.text')}
</p>
```

Вы также можете использовать API в [эндпойнтах](https://docs.astro.build/ru/guides/endpoints/), где объект `locals` доступен как часть контекста [эндпойнта](https://docs.astro.build/ru/reference/api-reference/#contextlocals):
Вы также можете использовать API в [эндпойнтах](https://docs.astro.build/ru/guides/endpoints/), где объект `locals` доступен как часть контекста [эндпойнта](https://docs.astro.build/en/reference/api-reference/#locals):

```ts title="src/pages/404.ts"
export const GET = (context) => {
Expand Down Expand Up @@ -392,7 +393,7 @@ const arabicDirection = Astro.locals.t.dir('ar');

## Доступ к текущей локали

Вы можете использовать [`Astro.currentLocale`](https://docs.astro.build/ru/reference/api-reference/#astrocurrentlocale) для получения текущей локали в компонентах `.astro`.
Вы можете использовать [`Astro.currentLocale`](https://docs.astro.build/en/reference/api-reference/#currentlocale) для получения текущей локали в компонентах `.astro`.

Следующий пример считывает текущую локаль и использует её с помощью хелпера [`getRelativeLocaleUrl()`](https://docs.astro.build/ru/reference/modules/astro-i18n/#getrelativelocaleurl) для генерации ссылки на страницу «О сайте» на текущем языке:

Expand Down
Loading

0 comments on commit f7e0d6a

Please sign in to comment.