From ca20e71d73f10def754e067d5c988b3ef3b82a69 Mon Sep 17 00:00:00 2001 From: liruifengv Date: Wed, 28 Feb 2024 17:44:58 +0800 Subject: [PATCH 01/17] i18n(zh-cn): Update plugins.mdx (#1566) --- .../content/docs/zh-cn/resources/plugins.mdx | 35 +++++++++++++------ 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/docs/src/content/docs/zh-cn/resources/plugins.mdx b/docs/src/content/docs/zh-cn/resources/plugins.mdx index a1e924cecc2..46b05e133aa 100644 --- a/docs/src/content/docs/zh-cn/resources/plugins.mdx +++ b/docs/src/content/docs/zh-cn/resources/plugins.mdx @@ -37,6 +37,26 @@ sidebar: title="starlight-typedoc" description=" 使用 TypeDoc 从 TypeScript 生成 Starlight 页面。" /> + + + + ## 社区工具和集成 @@ -51,16 +71,6 @@ import { CardGrid, LinkCard } from '@astrojs/starlight/components'; title="FeelBack" description="在文档页面中添加用户反馈系统。" /> - - + From b2a14076f82a8484f8ef13c2da0adaf204f9151a Mon Sep 17 00:00:00 2001 From: delucis Date: Wed, 28 Feb 2024 09:46:22 +0000 Subject: [PATCH 02/17] [ci] format --- docs/src/content/docs/zh-cn/resources/plugins.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/content/docs/zh-cn/resources/plugins.mdx b/docs/src/content/docs/zh-cn/resources/plugins.mdx index 46b05e133aa..1290afec37d 100644 --- a/docs/src/content/docs/zh-cn/resources/plugins.mdx +++ b/docs/src/content/docs/zh-cn/resources/plugins.mdx @@ -37,7 +37,7 @@ sidebar: title="starlight-typedoc" description=" 使用 TypeDoc 从 TypeScript 生成 Starlight 页面。" /> - - - + /> ## 社区工具和集成 @@ -81,7 +81,7 @@ import { CardGrid, LinkCard } from '@astrojs/starlight/components'; title="astro-live-code" description="将你的 MDX 代码块渲染为交互式组件" /> - Date: Wed, 28 Feb 2024 09:46:37 +0000 Subject: [PATCH 03/17] i18n(pt-PT): add "environmental-impact" page (#1561) --- docs/astro.config.mjs | 11 +- .../docs/pt-pt/environmental-impact.md | 139 ++++++++++++++++++ 2 files changed, 145 insertions(+), 5 deletions(-) create mode 100644 docs/src/content/docs/pt-pt/environmental-impact.md diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 40ec5df1459..4e591a023fd 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -136,6 +136,7 @@ export default defineConfig({ id: 'Dampak terhadap lingkungan', 'zh-CN': '环境影响', 'pt-BR': 'Impacto Ambiental', + 'pt-PT': 'Impacto Ambiental', ko: '환경적 영향', tr: 'Çevre Etkisi', ru: 'Влияние на окружающую среду', @@ -197,11 +198,11 @@ export default defineConfig({ ], plugins: process.env.CHECK_LINKS ? [ - starlightLinksValidator({ - errorOnFallbackPages: false, - errorOnInconsistentLocale: true, - }), - ] + starlightLinksValidator({ + errorOnFallbackPages: false, + errorOnInconsistentLocale: true, + }), + ] : [], }), ], diff --git a/docs/src/content/docs/pt-pt/environmental-impact.md b/docs/src/content/docs/pt-pt/environmental-impact.md new file mode 100644 index 00000000000..7db5d27db8d --- /dev/null +++ b/docs/src/content/docs/pt-pt/environmental-impact.md @@ -0,0 +1,139 @@ +--- +title: Documentação ecológica +description: Aprenda como o Starlight te pode ajudar a construir sites de documentação mais ecológicos e reduzir a pegada de carbono. +--- + +As estimativas para o impacto climático da indústria web variam entre [2%][sf] e [4% das emissões globais de carbono][bbc], aproximadamente o equivalente às emissões da indústria aeronáutica. +Há vários fatores complexos no cálculo do impacto ecológico de um website, mas este guia inclui algumas dicas para reduzir a pegada ambiental do seu site de documentação. + +A boa noticía é que, escolher o Starlight já é um bom começo! +De acordo com o "Website Carbon Calculator", este site é [mais limpo do que 99% das páginas web testadas][sl-carbon], produzindo 0.01g de CO₂ por cada visita à página. + +## Peso da página + +Quanto mais dados uma página web transfere mais recursos energéticos são necessários. +De acordo com [dados do HTTP Archive][http], em Abril de 2023, uma página web mediana necessitava que o utilizador baixasse mais de 2,000 KB. + +O Starlight constrói páginas que são o mais leve possível. +Por exemplo, na primeira visita, um utilizador vai descarregar menos do que 50 KB de dados comprimidos, ou seja, apenas 2.5% da mediana indicada pelo HTTP Archive. +Com uma boa estratégia de _cache_, as navegações subsequentes podem descarregar tão pouco quanto 10 KB. + +### Imagens +Enquanto o Starlight providencia uma boa base, as imagens que você adicionar à sua documentação podem aumentar o peso da sua página rapidamente. +O Starlight usa o [suporte a assets otimizados][assets] do Astro para otimizar imagens locais nos seus arquivos Markdown e MDX. + +### Componentes de UI + +Os componentes construídos com frameworks de UI como React ou Vue podem facilmente adicionar grandes quantidades de JavaScript a uma página. +Porque o Starlight é construído com o Astro, e graças às [Ilhas Astro][islands], esses componentes carregam, **por padrão, zero código JavaScript no lado do cliente**. + +### _Cache_ + +A _Cache_ é usada para controlar por quanto tempo um navegador armazena e reutiliza os dados já descarregados. +Uma boa estratégia de _caching_ garante que um utilizador receba o conteúdo novo o mais cedo possível assim que ele muda, mas também evita descarregar inutil e repetidamente o mesmo conteúdo sem que ele mude. + +A forma mais comum de configurar a _cache_ é com o [header HTTP `Cache-Control`][cache]. +Ao utilizar o Starlight, você pode definir um grande tempo de cache para todo o conteúdo do diretório `/_astro/`. +Este diretório contém CSS, JavaScript e outros artefactos em _bundle_ que podem ser seguramente _cached_ para sempre, reduzindo assim downloads desnecessários: + +``` +Cache-Control: public, max-age=604800, immutable +``` + +A forma de configurar a _cache_ depende do seu alojamento web. Por exemplo, o Vercel aplica por você esta estratégia de _cache_ sem necessidade de configuração adicional, já a definição de [cabeçalhos customizados para Netlify][ntl-headers] necessita que adicione um arquivo `public/_headers` ao seu projeto: + +``` +/_astro/* + Cache-Control: public + Cache-Control: max-age=604800 + Cache-Control: immutable +``` + +[cache]: https://csswizardry.com/2019/03/cache-control-for-civilians/ +[ntl-headers]: https://docs.netlify.com/routing/headers/ + +## Consumo de energia + +A forma com que uma página web é construída pode ter impacto na energia necessária para executá-la no dispositivo de um utilizador. +Por utilizar JavaScript ao mínimo, o Starlight reduz a quantidade de energia de processamento que o celular, tablet ou computador de um utilizador precisa para carregar e renderizar páginas. + +Tenha atenção ao adicionar funcionalidades como scripts de rastreamento de _Analytics_ ou conteúdo cheio de JavaScript como embeds de vídeo já que estes podem aumentar o consumo de energia da página. +Se você precisa de _Analytics_, considere escolher uma opção leve como [Cabin][cabin], [Fathom][fathom] ou [Plausible][plausible]. +Embeds como vídeos do YouTube e Vimeo podem ser melhorados se [carregar o vídeo mediante a interação do usuário][lazy-video]. +Pacotes como o [`astro-embed`][embed] podem ajudá-lo com alguns dos serviços comuns. + +:::tip[Sabia que?] +Fazer parse e compilação de JavaScript é uma das tarefas mais caras que os navegadores tem que fazer. +Comparado com a renderização de uma imagem JPEG de mesmo tamanho, [o JavaScript pode levar mais do que 30 vezes o tempo para processar][cost-of-js]. +::: + +[cabin]: https://withcabin.com/ +[fathom]: https://usefathom.com/ +[plausible]: https://plausible.io/ +[lazy-video]: https://web.dev/iframe-lazy-loading/ +[embed]: https://www.npmjs.com/package/astro-embed +[cost-of-js]: https://medium.com/dev-channel/the-cost-of-javascript-84009f51e99e + +## Alojamento + +O lugar onde uma página web é alojada pode ter um grande impacto no quão amigável ao ambiente o seu site de documentação é. +Os centros de dados e de servidores podem ter um grande impacto ecológico, incluindo alto consumo de eletricidade e uso intensivo de água. + +Escolher um alojamento que utiliza energia renovável significará menos emissões de carbono para o seu site. A [Green Web Directory][gwb] é uma ferramenta que poderá ajudá-lo a encontrar empresas de alojamento. + +[gwb]: https://www.thegreenwebfoundation.org/directory/ + +## Comparações + +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 | + +Dados recolhidos a 14 de Maio de 2023. Clique num dos links para ver os valores atualizados. + +[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/ +[dc-carbon]: https://www.websitecarbon.com/website/docus-dev-introduction-getting-started/ +[sx-carbon]: https://www.websitecarbon.com/website/sphinx-doc-org-en-master-usage-quickstart-html/ +[mk-carbon]: https://www.websitecarbon.com/website/mkdocs-org-getting-started/ +[nx-carbon]: https://www.websitecarbon.com/website/nextra-site-docs-docs-theme-start/ +[dy-carbon]: https://www.websitecarbon.com/website/docsify-js-org/ +[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/ + +## Mais recursos + +### Ferramentas + +- [Website Carbon Calculator][wcc] +- [GreenFrame](https://greenframe.io/) +- [Ecograder](https://ecograder.com/) +- [WebPageTest Carbon Control](https://www.webpagetest.org/carbon-control/) +- [Ecoping](https://ecoping.earth/) + +### Artigos e palestras + +- [“Building a greener web”](https://youtu.be/EfPoOt7T5lg), palestra por Michelle Barker +- [“Sustainable Web Development Strategies Within An Organization”](https://www.smashingmagazine.com/2022/10/sustainable-web-development-strategies-organization/), artigo por Michelle Barker +- [“A sustainable web for everyone”](https://2021.stateofthebrowser.com/speakers/tom-greenwood/), palestra por Tom Greenwood +- [“How Web Content Can Affect Power Usage”](https://webkit.org/blog/8970/how-web-content-can-affect-power-usage/), artigo por Benjamin Poulain e Simon Fraser + +[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/ +[islands]: https://docs.astro.build/pt-pt/concepts/islands/ +[wcc]: https://www.websitecarbon.com/ From d241ab9bc25750fade67d4621aa49ee6b6d16d88 Mon Sep 17 00:00:00 2001 From: delucis Date: Wed, 28 Feb 2024 09:47:14 +0000 Subject: [PATCH 04/17] [ci] format --- docs/astro.config.mjs | 10 +++++----- docs/src/content/docs/pt-pt/environmental-impact.md | 1 + 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 4e591a023fd..e83c6ee6589 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -198,11 +198,11 @@ export default defineConfig({ ], plugins: process.env.CHECK_LINKS ? [ - starlightLinksValidator({ - errorOnFallbackPages: false, - errorOnInconsistentLocale: true, - }), - ] + starlightLinksValidator({ + errorOnFallbackPages: false, + errorOnInconsistentLocale: true, + }), + ] : [], }), ], diff --git a/docs/src/content/docs/pt-pt/environmental-impact.md b/docs/src/content/docs/pt-pt/environmental-impact.md index 7db5d27db8d..e1c687fad1d 100644 --- a/docs/src/content/docs/pt-pt/environmental-impact.md +++ b/docs/src/content/docs/pt-pt/environmental-impact.md @@ -19,6 +19,7 @@ Por exemplo, na primeira visita, um utilizador vai descarregar menos do que 50 K Com uma boa estratégia de _cache_, as navegações subsequentes podem descarregar tão pouco quanto 10 KB. ### Imagens + Enquanto o Starlight providencia uma boa base, as imagens que você adicionar à sua documentação podem aumentar o peso da sua página rapidamente. O Starlight usa o [suporte a assets otimizados][assets] do Astro para otimizar imagens locais nos seus arquivos Markdown e MDX. From 3eaa1dd18453d7314ce5ea3a207379888c2de1f5 Mon Sep 17 00:00:00 2001 From: casungo Date: Wed, 28 Feb 2024 11:49:52 +0100 Subject: [PATCH 05/17] i18n(it): Update pages.mdx & plugins.mdx (#1567) * update to get 100% * fixed broken links * Update docs/src/content/docs/it/guides/pages.mdx Co-authored-by: Chris Swithinbank --------- Co-authored-by: Chris Swithinbank --- docs/src/content/docs/it/guides/pages.mdx | 40 ++++++++++++++----- .../src/content/docs/it/resources/plugins.mdx | 36 ++++++++++++----- 2 files changed, 57 insertions(+), 19 deletions(-) diff --git a/docs/src/content/docs/it/guides/pages.mdx b/docs/src/content/docs/it/guides/pages.mdx index a9e5d5bcb11..375d5a74a9e 100644 --- a/docs/src/content/docs/it/guides/pages.mdx +++ b/docs/src/content/docs/it/guides/pages.mdx @@ -104,15 +104,37 @@ Le seguenti proprietà differiscono dal frontmatter di Markdown: - La proprietà [`slug`](/it/reference/frontmatter/#slug) non è supportata e viene impostata automaticamente in base all'URL della pagina personalizzata. - L'opzione [`editUrl`](/it/reference/frontmatter/#editurl) richiede un URL per visualizzare un link di modifica. -- La proprietà [`sidebar`](/it/reference/frontmatter/#sidebar) non è supportata. Nel frontmatter di Markdown, questa opzione consente la personalizzazione dei [gruppi di link generati automaticamente](/it/reference/configuration/#sidebar), che non è applicabile alle pagine che utilizzano il componente ``. - -{/* ##### `sidebar` */} - -{/* **tipo:** `SidebarEntry[] | undefined` */} -{/* **predefinito:** la barra laterale generata in base alla [configurazione globale `sidebar`](/reference/configuration/#sidebar) */} - -{/* Fornisce una barra laterale di navigazione personalizzata per questo sito. */} -{/* Se non impostato, la pagina utilizzerà la barra laterale globale predefinita. */} +- La proprietà del frontmatter [`sidebar`](/it/reference/frontmatter/#sidebar) per personalizzare come appare la pagina in [gruppi di link autogenerati](/it/reference/configuration/#sidebar) non è disponibile. Le pagine che utilizzano il componente `` non fanno parte di una collezione e non possono essere aggiunte a un gruppo di barra laterale autogenerato. + +##### `sidebar` + +**tipo:** `SidebarEntry[]` +**predefinito:** la barra laterale generata in base alla [configurazione globale `sidebar`](/it/reference/configuration/#sidebar) + +Fornisce una barra laterale di navigazione personalizzata per questa pagina. +Se non impostato, la pagina utilizzerà la barra laterale globale predefinita. + +Ad esempio, la pagina seguente sovrascrive la barra laterale predefinita con un link alla homepage e un gruppo di link a diverse costellazioni. +La pagina corrente nella barra laterale è impostata utilizzando la proprietà `isCurrent` e un `badge` opzionale è stato aggiunto a un elemento di link. + +```astro {3-13} + + Contenuto di esempio. + +``` ##### `hasSidebar` diff --git a/docs/src/content/docs/it/resources/plugins.mdx b/docs/src/content/docs/it/resources/plugins.mdx index 5a86a2c77c1..6cb0a917f31 100644 --- a/docs/src/content/docs/it/resources/plugins.mdx +++ b/docs/src/content/docs/it/resources/plugins.mdx @@ -38,6 +38,26 @@ Estendi il tuo sito con plugin ufficiali supportati dal team Starlight e plugin title="starlight-typedoc" description="Genera pagine Starlight da TypeScript usando TypeDoc." /> + + + + ## Strumenti e integrazioni della community @@ -52,16 +72,6 @@ Questi strumenti e integrazioni della community possono essere utilizzati per ag title="FeelBack" description="Aggiungi un sistema di feedback utente alle tue pagine di documentazione." /> - - + + From bd556b42a4011f0740340d45210f823fd3c81976 Mon Sep 17 00:00:00 2001 From: delucis Date: Wed, 28 Feb 2024 10:50:31 +0000 Subject: [PATCH 06/17] [ci] format --- docs/src/content/docs/it/resources/plugins.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/src/content/docs/it/resources/plugins.mdx b/docs/src/content/docs/it/resources/plugins.mdx index 6cb0a917f31..c370bb69cdb 100644 --- a/docs/src/content/docs/it/resources/plugins.mdx +++ b/docs/src/content/docs/it/resources/plugins.mdx @@ -88,4 +88,3 @@ Questi strumenti e integrazioni della community possono essere utilizzati per ag description="Estensione di Visual Studio Code che ti aiuta a tradurre le pagine Starlight." /> - From 585ac3f7c122fb1848537c2a0ee0e3bba016a184 Mon Sep 17 00:00:00 2001 From: Martin Trapp <94928215+martrapp@users.noreply.github.com> Date: Thu, 29 Feb 2024 17:58:54 +0100 Subject: [PATCH 07/17] Updates internal github actions to the latest versions (#1569) * Updates internal github actions to the latest versions * plus stefanzweifel/git-auto-commit-action@v5 * updates another Node.js 16 github action * Updates deprecated Node.js 16 github actions * removed changeset --- .github/workflows/ci.yml | 24 ++++++++++++------------ .github/workflows/format.yml | 8 ++++---- .github/workflows/release.yml | 6 +++--- .github/workflows/size-limit.yml | 4 ++-- .github/workflows/welcome-bot.yml | 2 +- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 45f4d4b4410..fbde0027a03 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,9 +20,9 @@ jobs: name: Run unit tests runs-on: ubuntu-20.04 steps: - - uses: actions/checkout@v3 - - uses: pnpm/action-setup@v2 - - uses: actions/setup-node@v3 + - uses: actions/checkout@v4 + - uses: pnpm/action-setup@v3 + - uses: actions/setup-node@v4 with: node-version: ${{ env.NODE_VERSION }} cache: 'pnpm' @@ -35,13 +35,13 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup PNPM - uses: pnpm/action-setup@v2 + uses: pnpm/action-setup@v3 - name: Setup Node - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ env.NODE_VERSION }} cache: 'pnpm' @@ -63,9 +63,9 @@ jobs: name: Docs site builds on Windows runs-on: windows-latest steps: - - uses: actions/checkout@v3 - - uses: pnpm/action-setup@v2 - - uses: actions/setup-node@v3 + - uses: actions/checkout@v4 + - uses: pnpm/action-setup@v3 + - uses: actions/setup-node@v4 with: node-version: ${{ env.NODE_VERSION }} cache: 'pnpm' @@ -79,13 +79,13 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup PNPM - uses: pnpm/action-setup@v2 + uses: pnpm/action-setup@v3 - name: Setup Node - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ env.NODE_VERSION }} cache: 'pnpm' diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index 4156fc401b2..b5de351b608 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -10,13 +10,13 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out code using Git - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: ref: ${{ github.head_ref }} # Needs access to push to main token: ${{ secrets.FREDKBOT_GITHUB_TOKEN }} - - uses: pnpm/action-setup@v2 - - uses: actions/setup-node@v3 + - uses: pnpm/action-setup@v3 + - uses: actions/setup-node@v4 with: node-version: 18 cache: 'pnpm' @@ -24,7 +24,7 @@ jobs: - name: Format with Prettier run: pnpm format - name: Commit changes - uses: stefanzweifel/git-auto-commit-action@v4 + uses: stefanzweifel/git-auto-commit-action@v5 with: commit_message: '[ci] format' branch: ${{ github.head_ref }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8dc3aafde6d..fe406013740 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -12,16 +12,16 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits fetch-depth: 0 - name: Setup PNPM - uses: pnpm/action-setup@v2 + uses: pnpm/action-setup@v3 - name: Setup Node - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: 18 cache: 'pnpm' diff --git a/.github/workflows/size-limit.yml b/.github/workflows/size-limit.yml index b84554e10fd..f2586e259a9 100644 --- a/.github/workflows/size-limit.yml +++ b/.github/workflows/size-limit.yml @@ -18,7 +18,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: pnpm/action-setup@v2 + - uses: pnpm/action-setup@v3 - run: pnpm i - run: 'pnpm build:examples' - run: pnpm size @@ -31,7 +31,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: pnpm/action-setup@v2 + - uses: pnpm/action-setup@v3 - name: Run size-limit uses: andresz1/size-limit-action@dd31dce7dcc72a041fd3e49abf0502b13fc4ce05 with: diff --git a/.github/workflows/welcome-bot.yml b/.github/workflows/welcome-bot.yml index 30994f4a411..a433fe8088b 100644 --- a/.github/workflows/welcome-bot.yml +++ b/.github/workflows/welcome-bot.yml @@ -13,7 +13,7 @@ jobs: name: Welcome First-Time Contributors runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: zephyrproject-rtos/action-first-interaction@7e6446f8439d8b4399169880c36a3a12b5747699 with: repo-token: ${{ secrets.FREDKBOT_GITHUB_TOKEN }} From a8ea6f08c11e46f55e3c20e77c197284b1e7061a Mon Sep 17 00:00:00 2001 From: liruifengv Date: Fri, 1 Mar 2024 01:16:31 +0800 Subject: [PATCH 08/17] i18n(zh-cn): Update pages.mdx (#1565) * i18n(zh-cn): Update pages.mdx * Update page labels and titles in Chinese --------- Co-authored-by: Chris Swithinbank --- docs/src/content/docs/zh-cn/guides/pages.mdx | 40 +++++++++++++++----- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/docs/src/content/docs/zh-cn/guides/pages.mdx b/docs/src/content/docs/zh-cn/guides/pages.mdx index 4d0cc406de7..634fd0348e1 100644 --- a/docs/src/content/docs/zh-cn/guides/pages.mdx +++ b/docs/src/content/docs/zh-cn/guides/pages.mdx @@ -106,15 +106,37 @@ import CustomComponent from './CustomComponent.astro'; - [`slug`](/zh-cn/reference/frontmatter/#slug) 属性不受支持，并且会根据自定义页面的 URL 自动设置。 - [`editUrl`](/zh-cn/reference/frontmatter/#editurl) 选项需要一个 URL 来显示编辑链接。 -- [`sidebar`](/zh-cn/reference/frontmatter/#sidebar) 属性不受支持。在 Markdown frontmatter 中，此选项允许自定义[自动生成的链接组](/zh-cn/reference/configuration/#sidebar)，这不适用于使用 `` 组件的页面。 - -{/* ##### `sidebar` */} - -{/* **type:** `SidebarEntry[] | undefined` */} -{/* **default:** the sidebar generated based on the [global `sidebar` config](/reference/configuration/#sidebar) */} - -{/* Provide a custom site navigation sidebar for this page. */} -{/* If not set, the page will use the default global sidebar. */} +- 用于自定义页面如何在 [自动生成的链接组](/zh-cn/reference/configuration/#sidebar) 中显示的 [`sidebar`](/zh-cn/reference/frontmatter/#sidebar) frontmatter 属性不可用。使用 `` 组件的页面不是集合的一部分，不能添加到自动生成的侧边栏组中。 + +##### `sidebar` + +**类型：** `SidebarEntry[]` +**默认值：** 根据 [全局 `sidebar` 配置](/zh-cn/reference/configuration/#sidebar) 生成的侧边栏 + +为此页面提供自定义站点导航侧边栏。 +如果未设置，此页面将使用默认的全局侧边栏。 + +例如，以下页面使用指向主页的链接和一组指向不同星座的链接覆盖了默认的侧边栏。 +侧边栏中的当前页面使用 `isCurrent` 属性设置，一个可选的 `badge` 已经添加到了一个链接项中。 + +```astro {3-13} + + 示例内容。 + +``` ##### `hasSidebar` From b9041c7fc68523eb2e1e98a78eeb8078a7a11378 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Jaime=20Gil=20Sim=C3=B5es?= Date: Fri, 1 Mar 2024 15:10:01 +0000 Subject: [PATCH 09/17] i18n(pt-PT): add "manual-setup" page (#1570) --- docs/astro.config.mjs | 3 + .../content/docs/pt-pt/getting-started.mdx | 11 +- docs/src/content/docs/pt-pt/manual-setup.mdx | 129 ++++++++++++++++++ 3 files changed, 133 insertions(+), 10 deletions(-) create mode 100644 docs/src/content/docs/pt-pt/manual-setup.mdx diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index e83c6ee6589..b79cf4bafce 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -79,6 +79,7 @@ export default defineConfig({ id: 'Mulai dari sini', 'zh-CN': '从这里开始', 'pt-BR': 'Comece Aqui', + 'pt-PT': 'Comece Aqui', ko: '여기서부터', tr: 'Buradan Başlayın', ru: 'Начать отсюда', @@ -98,6 +99,7 @@ export default defineConfig({ id: 'Memulai', 'zh-CN': '开始使用', 'pt-BR': 'Introdução', + 'pt-PT': 'Introdução', ko: '시작하기', tr: 'Başlarken', ru: 'Введение', @@ -117,6 +119,7 @@ export default defineConfig({ id: 'Instalasi Manual', 'zh-CN': '手动配置', 'pt-BR': 'Instalação Manual', + 'pt-PT': 'Instalação Manual', ko: '수동으로 설정하기', tr: 'Elle Kurulum', ru: 'Установка вручную', diff --git a/docs/src/content/docs/pt-pt/getting-started.mdx b/docs/src/content/docs/pt-pt/getting-started.mdx index 4f87ca44cd5..830fcab5ac1 100644 --- a/docs/src/content/docs/pt-pt/getting-started.mdx +++ b/docs/src/content/docs/pt-pt/getting-started.mdx @@ -81,16 +81,7 @@ Abra esse URL para começar a navegar no seu site. ### Crie conteúdo -O Starlight está pronto para você adicionar novos conteúdos, ou trazer os seus arquivos já existentes! - -#### Formatos de arquivo - -O Starlight suporta a escrita de conteúdo em Markdown e MDX sem precisar de nenhuma configuração extra. -Pode também adicionar suporte para Markdoc instalando a [integração experimental Astro Markdoc](https://docs.astro.build/pt-br/guides/integrations-guide/markdoc/). - -#### Adicione páginas - -Adicione novas páginas ao seu site criando arquivos `.md` ou `.mdx` em `src/content/docs/`. +O Starlight está pronto para você adicionar novos conteúdos, ou trazer os seus arquivos existentes! Adicione páginas ao seu site criando ficheiros _Markdown_ no directório `src/content/docs/`. diff --git a/docs/src/content/docs/pt-pt/manual-setup.mdx b/docs/src/content/docs/pt-pt/manual-setup.mdx new file mode 100644 index 00000000000..98b601153ca --- /dev/null +++ b/docs/src/content/docs/pt-pt/manual-setup.mdx @@ -0,0 +1,129 @@ +--- +title: Instalação Manual +description: Aprenda como instalar o Starlight manualmente e a adicioná-lo a um projeto Astro existente. +--- + +import { Tabs, TabItem } from '@astrojs/starlight/components'; + +A forma mais rápida de criar um novo site Starlight é através do comando `create astro` como é mostrado no [guia de Introdução](/pt-pt/getting-started/#crie-um-novo-projeto). +Se você deseja adicionar o Starlight a um projeto Astro existente, este guia irá explicar-lhe como. + +## Instalação do Starlight + +Para seguir este guia, você vai precisar de um projeto Astro existente. + +### Adicione a integração Starlight + +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: + + + + ```sh + npx astro add starlight + ``` + + + ```sh + pnpm astro add starlight + ``` + + + ```sh + yarn astro add starlight + ``` + + + +Este passo irá instalar as dependências necessárias e adicionar o Starlight ao array de `integrations` do seu arquivo de configuração do Astro. + +### Configure a integração + +A integração Starlight é configurada no arquivo `astro.config.mjs`. + +Para começar adicione um `title`: + +```js ins={8} +// astro.config.mjs +import { defineConfig } from 'astro/config'; +import starlight from '@astrojs/starlight'; + +export default defineConfig({ + integrations: [ + starlight({ + title: 'O meu magnífico site de documentação', + }), + ], +}); +``` + +Encontre todas as opções disponíveis na referência sobre [configuração do Starlight](/pt-pt/reference/configuration/). + +### 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`. + +Crie ou atualize o arquivo de configuração de conteúdo, adicionando uma coleção `docs` que usa o esquema `docsSchema` do Starlight: + +```js ins={3,6} +// src/content/config.ts +import { defineCollection } from 'astro:content'; +import { docsSchema } from '@astrojs/starlight/schema'; + +export const collections = { + docs: defineCollection({ schema: docsSchema() }), +}; +``` + +### Adicione conteúdo + +Agora que o Starlight está configurado é hora de adicionar algum conteúdo! + +Crie um diretório `src/content/docs/` e comece por adicionar um arquivo `index.md`. +Este arquivo corresponderá à página inicial do seu site: + +```md +--- +# src/content/docs/index.md +title: A minha documentação +description: Aprenda mais sobre meu projeto neste site de documentação construído com o Starlight. +--- + +Bem-vindo ao meu projeto! +``` + +O Starlight usa _routing_ baseado em arquivos, o que significa que qualquer arquivo Markdown, MDX ou Markdoc em `src/content/docs/` corresponderá a uma página no seu site. Os metadados do frontmatter (campos `title` e `description` no exemplo acima) podem mudar como cada página é apresentada. +Veja todas as opções disponíveis na [referência do frontmatter](/pt-pt/reference/frontmatter/). + +## 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. + +### Utilize o Starlight como um subcaminho + +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/`. + +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/`: + +import FileTree from '~/components/file-tree.astro'; + + + +- src/ + - content/ + - docs/ + - **guias/** + - guia.md + - index.md + - pages/ +- astro.config.mjs + + + +No futuro, planeamos melhorar o suporte deste caso de uso para evitar a necessidade de um diretório adicional dentro do `src/content/docs/`. + +### 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. + +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. \ No newline at end of file From 73390273b52727ac8c95275eb0c1c48eb9ea60d4 Mon Sep 17 00:00:00 2001 From: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> Date: Fri, 1 Mar 2024 09:37:18 -0600 Subject: [PATCH 10/17] i18n(es): update `components` (#1547) * i18n(es): update components * fix: broken link and translation * Apply suggestions from Chris & Kevin's review Co-authored-by: Chris Swithinbank <357379+delucis@users.noreply.github.com> Co-authored-by: Kevin Zuniga Cuellar <46791833+kevinzunigacuellar@users.noreply.github.com> --------- Co-authored-by: Kevin Zuniga Cuellar <46791833+kevinzunigacuellar@users.noreply.github.com> Co-authored-by: Chris Swithinbank Co-authored-by: Waxer59 <78129249+Waxer59@users.noreply.github.com> --- .../src/content/docs/es/guides/components.mdx | 55 +++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/docs/src/content/docs/es/guides/components.mdx b/docs/src/content/docs/es/guides/components.mdx index 8e26ea0569a..bd6e7f64f7c 100644 --- a/docs/src/content/docs/es/guides/components.mdx +++ b/docs/src/content/docs/es/guides/components.mdx @@ -173,6 +173,61 @@ import { LinkCard } from '@astrojs/starlight/components'; +### Apartados + +Los apartados son útiles para mostrar información secundaria junto al contenido principal de una página. + +Un `