Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[i18nIgnore] Integration READMEs in docs! #5839

Merged
merged 11 commits into from
Dec 21, 2023
3 changes: 3 additions & 0 deletions scripts/generate-integration-pages.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Can this whole file just be deleted?
// Otherwise, including for Chris to edit

import kleur from 'kleur';
import type {
Blockquote,
Expand Down
1 change: 1 addition & 0 deletions src/components/starlight/EditLink.astro
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---

sarah11918 marked this conversation as resolved.
Show resolved Hide resolved
import { Icon } from '@astrojs/starlight/components';
import type { Props } from '@astrojs/starlight/props';

Expand Down
4 changes: 2 additions & 2 deletions src/components/starlight/PageTitle.astro
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const { data } = Astro.props.entry;
</h1>
<div class="integration-metadata">
<Version pkgName={data.title} />
<a href={data.githubURL}>
<a href={data.githubIntegrationURL}>
<Icon size="1rem" name="github" /> GitHub
</a>
<a href={'https://www.npmjs.com/package/' + data.title}>
Expand All @@ -27,7 +27,7 @@ const { data } = Astro.props.entry;
</svg>
npm
</a>
<a href={data.githubURL + 'CHANGELOG.md'}>
<a href={data.githubIntegrationURL + 'CHANGELOG.md'}>
<Icon size="1rem" name="list-format" /> Changelog
</a>
</div>
Expand Down
3 changes: 1 addition & 2 deletions src/content/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ export const integrationSchema = baseSchema.extend({
'"title" must start with "@astrojs/" for integration docs.'
),
category: z.enum(['renderer', 'adapter', 'other']),
hasREADME: z.literal(true).default(true),
githubURL: z.string().url(),
githubIntegrationURL: z.string().url(),
});

export const migrationSchema = baseSchema.extend({
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/alpinejs.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/alpinejs/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/alpinejs'
description: Learn how to use the @astrojs/alpinejs framework integration to extend component support in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/alpinejs/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/alpinejs/'
category: renderer
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** adds [Alpine.js](https://alpinejs.dev/) to your project so that you can use Alpine.js anywhere on your page.

## Installation
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/cloudflare.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/adapters/tree/main/packages/cloudflare/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/cloudflare'
description: Learn how to use the @astrojs/cloudflare SSR adapter to deploy your Astro project.
githubURL: 'https://github.com/withastro/adapters/tree/main/packages/cloudflare/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/adapters/tree/main/packages/cloudflare/'
category: adapter
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

An SSR adapter for use with Cloudflare Pages Functions targets. Write your code in Astro/Javascript and deploy to Cloudflare Pages.

## Install
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/lit.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/lit/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/lit'
description: Learn how to use the @astrojs/lit framework integration to extend component support in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/lit/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/lit/'
category: renderer
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** enables server-side rendering and client-side hydration for your [Lit](https://lit.dev/) custom elements.

## Installation
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/markdoc.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/markdoc/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/markdoc'
description: Learn how to use the @astrojs/markdoc integration in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/markdoc/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/markdoc/'
category: other
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** enables the usage of [Markdoc](https://markdoc.dev/) to create components, pages, and content collection entries.

## Why Markdoc?
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/mdx.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/mdx/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/mdx'
description: Learn how to use the @astrojs/mdx integration in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/mdx/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/mdx/'
category: other
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** enables the usage of [MDX](https://mdxjs.com/) components and allows you to create pages as `.mdx` files.

## Why MDX?
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/netlify.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/adapters/tree/main/packages/netlify/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/netlify'
description: Learn how to use the @astrojs/netlify SSR adapter to deploy your Astro project.
githubURL: 'https://github.com/withastro/adapters/tree/main/packages/netlify/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/adapters/tree/main/packages/netlify/'
category: adapter
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This adapter allows Astro to deploy your [`hybrid` or `server` rendered site](/en/core-concepts/rendering-modes/#on-demand-rendered) to [Netlify](https://www.netlify.com/).

Learn how to deploy your Astro site in our [Netlify deployment guide](/en/guides/deploy/netlify/).
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/node.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/node/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/node'
description: Learn how to use the @astrojs/node SSR adapter to deploy your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/node/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/node/'
category: adapter
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This adapter allows Astro to deploy your SSR site to Node targets.

## Why Astro Node.js
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/partytown.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/partytown/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/partytown'
description: Learn how to use the @astrojs/partytown integration in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/partytown/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/partytown/'
category: other
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** enables [Partytown](https://partytown.builder.io/) in your Astro project.

## Why Astro Partytown
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/preact.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/preact/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/preact'
description: Learn how to use the @astrojs/preact framework integration to extend component support in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/preact/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/preact/'
category: renderer
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** enables server-side rendering and client-side hydration for your [Preact](https://preactjs.com/) components.

## Why Preact?
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/react.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/react/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/react'
description: Learn how to use the @astrojs/react framework integration to extend component support in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/react/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/react/'
category: renderer
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** enables server-side rendering and client-side hydration for your [React](https://react.dev/) components.

## Installation
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/sitemap.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/sitemap/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/sitemap'
description: Learn how to use the @astrojs/sitemap integration in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/sitemap/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/sitemap/'
category: other
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** generates a sitemap based on your pages when you build your Astro project.

## Why Astro Sitemap
Expand Down
16 changes: 1 addition & 15 deletions src/content/docs/en/guides/integrations-guide/solid-js.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
---
# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
# and pulls content directly from the package’s README.
# DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
# For corrections, please edit the package README at
# https://github.com/withastro/astro/tree/main/packages/integrations/solid/
#
# TRANSLATORS: please remove this note and the <DontEditWarning/> component.

type: integration
title: '@astrojs/solid-js'
description: Learn how to use the @astrojs/solid-js framework integration to extend component support in your Astro project.
githubURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/solid/'
hasREADME: true
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/solid/'
category: renderer
i18nReady: true
---

import Video from '~/components/Video.astro';
import DontEditWarning from '~/components/DontEditWarning.astro';

<DontEditWarning/>

This **[Astro integration][astro-integration]** enables server-side rendering and client-side hydration for your [SolidJS](https://www.solidjs.com/) components.

## Installation
Expand Down
Loading
Loading