Skip to content

Commit

Permalink
Merge branch 'main' into hd-feat-docs-components
Browse files Browse the repository at this point in the history
* main: (121 commits)
  i18n(zh-cn): Update components.mdx (withastro#2240)
  i18n(zh-cn): Update frontmatter.mdx (withastro#2239)
  i18n(zh-cn): Update pages.mdx (withastro#2238)
  i18n(zh-cn): Add synced tabs persistence (withastro#2236)
  Update examples index hero button action variants (withastro#2234)
  i18n(fr): update `guides/components` (withastro#2232)
  i18n(fr): update `guides/pages` (withastro#2224)
  [i18nIgnore] docs: update `index.mdx` hero action buttons variants (withastro#2233)
  i18n(fr): update `reference/frontmatter` (withastro#2223)
  i18n(fr): update `index` (withastro#2222)
  docs: add Cloudflare Docs to showcase (withastro#2221)
  i18n(ko-KR): update `pages.mdx` (withastro#2227)
  i18n(ko-KR): update `components.mdx` (withastro#2225)
  i18n(ko-KR): update `fontmatter.md` (withastro#2231)
  i18n(ko-KR): update `manual-setup.mdx` (withastro#2230)
  [ci] format
  i18n(ko-KR): update `index.mdx` (withastro#2229)
  i18n(ko-KR): update `site-search.mdx` (withastro#2228)
  i18n(ko-KR): update `customization.mdx` (withastro#2226)
  i18n(fr): add missing `syncKey` to various pages (withastro#2218)
  ...
  • Loading branch information
HiDeoo committed Aug 19, 2024
2 parents 3229ea6 + 46aaab8 commit ea2fa02
Show file tree
Hide file tree
Showing 149 changed files with 2,714 additions and 1,080 deletions.
5 changes: 0 additions & 5 deletions .changeset/orange-turtles-scream.md

This file was deleted.

8 changes: 0 additions & 8 deletions .changeset/small-kangaroos-smile.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/welcome-bot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
If they spot any issues you will see some error messages on this PR.
Don’t hesitate to ask any questions if you’re not sure what these mean!
2. In a few minutes, you’ll be able to see a preview of your changes on Vercel 🤩
2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩
3. One or more of our maintainers will take a look and may ask you to make changes.
We try to be responsive, but don’t worry if this takes a few days.
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ pnpm-lock.yaml

# Test snapshots
**/__tests__/**/snapshots

# https://github.com/withastro/prettier-plugin-astro/issues/337
packages/starlight/user-components/Tabs.astro
16 changes: 7 additions & 9 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,12 @@ export const locales = {
uk: { label: 'Українська', lang: 'uk' },
};

/* https://vercel.com/docs/projects/environment-variables/system-environment-variables#system-environment-variables */
const VERCEL_PREVIEW_SITE =
process.env.VERCEL_ENV !== 'production' &&
process.env.VERCEL_URL &&
`https://${process.env.VERCEL_URL}`;
/* https://docs.netlify.com/configure-builds/environment-variables/#read-only-variables */
const NETLIFY_PREVIEW_SITE = process.env.CONTEXT !== 'production' && process.env.DEPLOY_PRIME_URL;

const site = VERCEL_PREVIEW_SITE || 'https://starlight.astro.build/';
const site = NETLIFY_PREVIEW_SITE || 'https://starlight.astro.build/';
const ogUrl = new URL('og.jpg?v=1', site).href;
const ogImageAlt = 'Make your docs shine with Starlight';

export default defineConfig({
site,
Expand Down Expand Up @@ -58,11 +57,11 @@ export default defineConfig({
},
{
tag: 'meta',
attrs: { property: 'og:image', content: site + 'og.jpg?v=1' },
attrs: { property: 'og:image', content: ogUrl },
},
{
tag: 'meta',
attrs: { property: 'twitter:image', content: site + 'og.jpg?v=1' },
attrs: { property: 'og:image:alt', content: ogImageAlt },
},
],
customCss: process.env.NO_GRADIENTS ? [] : ['./src/assets/landing.css'],
Expand Down Expand Up @@ -159,7 +158,6 @@ export default defineConfig({
},
{
label: 'Resources',
badge: 'New',
translations: {
'zh-CN': '资源',
fr: 'Ressources',
Expand Down
4 changes: 4 additions & 0 deletions docs/public/_headers
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/_astro/*
Cache-Control: public
Cache-Control: max-age=31536000
Cache-Control: immutable
11 changes: 11 additions & 0 deletions docs/public/_redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Proxy to Phat Houston from our Product Hunt launch — site operated by Otterlord
/ph/* https://astro-houston-ph.pages.dev/ph/:splat 200

# Moved content
/zh/* /zh-cn/:splat
/showcase/ /resources/showcase/
/:lang/showcase/ /:lang/resources/showcase/

# Translated 404s
/:lang/* /:lang/404/ 404
/* /404/ 404
4 changes: 4 additions & 0 deletions docs/src/assets/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
User-agent: *
Allow: /

Sitemap: https://starlight.astro.build/sitemap-index.xml
Binary file added docs/src/assets/showcase/codesweetly.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/document.saasfly.io.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/feedbackspark.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/grpc.md.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/quotesdomain.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/styledictionary.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/ucexlly.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/ui.full.dev.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions docs/src/components/showcase-sites.astro
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,39 @@ import FluidGrid from './fluid-grid.astro';
thumbnail="www.devhealthos.com.png"
/>
<Card title="Orama" href="https://docs.orama.com/" thumbnail="docs.orama.com.png" />
<Card
title="FeedbackSpark"
href="https://feedbackspark.com/docs/"
thumbnail="feedbackspark.com.png"
/>
<Card title="Fulldev UI" href="https://ui.full.dev" thumbnail="ui.full.dev.png" />
<Card title="UCEXLLY" href="https://www.ucexlly.com/" thumbnail="ucexlly.com.png" />
<Card
title="QuotesDomain"
href="https://www.quotesdomain.com/"
thumbnail="quotesdomain.com.png"
/>
<Card title="Saasfly" href="https://document.saasfly.io/" thumbnail="document.saasfly.io.png" />
<Card
title="freeCodeCamp"
href="https://contribute.freecodecamp.org/intro/"
thumbnail="contribute.freecodecamp.org.png"
/>
<Card
title="Style Dictionary"
href="https://styledictionary.com/"
thumbnail="styledictionary.com.png"
/>
<Card title="CodeSweetly" href="https://codesweetly.com/" thumbnail="codesweetly.com.png" />
<Card title="grpcmd" href="https://grpc.md/" thumbnail="grpc.md.png" />
<Card
title="Pokemon Database"
href="https://pokemon-siace.netlify.app/"
thumbnail="pokemon-siace.netlify.app.png"
/>
<Card
title="Cloudflare Docs"
href="https://developers.cloudflare.com/"
thumbnail="developers.cloudflare.com.png"
/>
</FluidGrid>
2 changes: 1 addition & 1 deletion docs/src/content/docs/da/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ hero:
actions:
- text: Kom igang
icon: right-arrow
variant: primary
link: /da/getting-started/
- text: Se på GitHub
icon: external
variant: minimal
link: https://github.com/withastro/starlight
---

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/de/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ hero:
actions:
- text: Los geht's
icon: right-arrow
variant: primary
link: /de/getting-started/
- text: Auf GitHub
icon: external
variant: minimal
link: https://github.com/withastro/starlight
---

Expand Down
30 changes: 16 additions & 14 deletions docs/src/content/docs/environmental-impact.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,20 +89,21 @@ Choosing a host that uses renewable energy will mean lower carbon emissions for
Curious how other docs frameworks compare?
These tests with the [Website Carbon Calculator][wcc] compare similar pages built with different tools.

| Framework | CO₂ per page visit |
| --------------------------- | ------------------ |
| [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>Data collected on 14 May 2023. Click a link to see up-to-date figures.</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>Data collected on 22 July 2024. Click a link to see up-to-date figures.</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 @@ These tests with the [Website Carbon Calculator][wcc] compare similar pages buil
[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/

## More resources

Expand Down
30 changes: 16 additions & 14 deletions docs/src/content/docs/es/environmental-impact.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,20 +73,21 @@ Elegir un proveedor de alojamiento que utilice energía renovable significa tene
¿Curioso por saber cómo se comparan otros frameworks de documentación?
Estas pruebas con el [Calculadora de Carbono de Sitios Web][wcc] comparan páginas similares construidas con diferentes herramientas.

| Framework | CO₂ por visita a la 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>Datos recopilados el 14 de mayo de 2023. Haz clic en un enlace para ver cifras actualizadas.</small>
| Framework | CO₂ por visita a la página | Calificación |
| --------------------------- | -------------------------- | :----------: |
| [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>Datos recopilados el 22 de Julio de 2024. Haz clic en un enlace para ver cifras actualizadas.</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 @@ -98,6 +99,7 @@ Estas pruebas con el [Calculadora de Carbono de Sitios Web][wcc] comparan págin
[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/

## Más recursos

Expand Down
Loading

0 comments on commit ea2fa02

Please sign in to comment.