michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Integration README fixes (#3865)

Browse source 
* Remove stray XML tag in sitemap integration README

* Fix link errors

* Add changeset
This commit is contained in:
Chris Swithinbank 2022-07-08 21:56:24 +02:00 committed by GitHub
parent 70b0246d4c
commit 1f9e4857ff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
.changeset/breezy-ravens-sort.md Normal file
View file

@ -0,0 +1,11 @@
---
'@astrojs/deno': patch
'@astrojs/image': patch
'@astrojs/netlify': patch
'@astrojs/node': patch
'@astrojs/prefetch': patch
'@astrojs/sitemap': patch
'@astrojs/vercel': patch
---
Small README fixes

2
packages/integrations/deno/README.md
View file

@ -42,7 +42,7 @@ export default defineConfig({
## Usage
After [performing a build](https://docs.astro.build/en/guides/deploy/#building-the-app) there will be a `dist/server/entry.mjs` module. You can start a server by importing this module in your Deno app:
After [performing a build](https://docs.astro.build/en/guides/deploy/#building-your-site-locally) there will be a `dist/server/entry.mjs` module. You can start a server by importing this module in your Deno app:
```js
import './dist/entry.mjs';

2
packages/integrations/image/README.md
View file

@ -4,7 +4,7 @@
This **[Astro integration][astro-integration]** makes it easy to optimize images in your [Astro project](https://astro.build), with full support for SSG builds and server-side rendering!
- <strong>[Why `@astrojs/image`?](#why-astrojs-image)</strong>
- <strong>[Why `@astrojs/image`?](#why-astrojsimage)</strong>
- <strong>[Installation](#installation)</strong>
- <strong>[Usage](#usage)</strong>
- <strong>[Configuration](#configuration)</strong>

4
packages/integrations/netlify/README.md
View file

@ -56,9 +56,9 @@ export default defineConfig({
```
## Usage
[Read the full deployment guide here.](https://docs.astro.build/en/guides/deploy/vercel)
[Read the full deployment guide here.](https://docs.astro.build/en/guides/deploy/netlify/)
After [performing a build](https://docs.astro.build/en/guides/deploy/#building-the-app) the `netlify/` folder will contain [Netlify Functions](https://docs.netlify.com/functions/overview/) in the `netlify/functions/` folder.
After [performing a build](https://docs.astro.build/en/guides/deploy/#building-your-site-locally) the `netlify/` folder will contain [Netlify Functions](https://docs.netlify.com/functions/overview/) in the `netlify/functions/` folder.
Now you can deploy. Install the [Netlify CLI](https://docs.netlify.com/cli/get-started/) and run:

2
packages/integrations/node/README.md
View file

@ -43,7 +43,7 @@ export default defineConfig({
## Usage
After [performing a build](https://docs.astro.build/en/guides/deploy/#building-the-app) there will be a `dist/server/entry.mjs` module that exposes a `handler` function. This works like a [middleware](https://expressjs.com/en/guide/using-middleware.html) function: it can handle incoming requests and respond accordingly.
After [performing a build](https://docs.astro.build/en/guides/deploy/#building-your-site-locally) there will be a `dist/server/entry.mjs` module that exposes a `handler` function. This works like a [middleware](https://expressjs.com/en/guide/using-middleware.html) function: it can handle incoming requests and respond accordingly.
### Using a middleware framework

1
packages/integrations/prefetch/README.md
View file

@ -7,7 +7,6 @@
- <strong>[Examples](#examples)</strong>
- <strong>[Troubleshooting](#troubleshooting)</strong>
- <strong>[Contributing](#contributing)</strong>
- <strong>[Changelog](#changelog)</strong>
## Why Prefetch?

1
packages/integrations/sitemap/README.md
View file

@ -109,7 +109,6 @@ Example of generated sitemap content for a two-page website:
```
**sitemap-0.xml**
<?xml version="1.0" encoding="UTF-8"?>
```xml
<?xml version="1.0" encoding="UTF-8"?>

2
packages/integrations/vercel/README.md
View file

@ -59,7 +59,7 @@ import vercel from '@astrojs/vercel/static';
## Usage
📚 **[Read the full deployment guide here.](https://docs.astro.build/en/guides/deploy/vercel)**
📚 **[Read the full deployment guide here.](https://docs.astro.build/en/guides/deploy/vercel/)**
You can deploy by CLI (`vercel deploy`) or by connecting your new repo in the [Vercel Dashboard](https://vercel.com/). Alternatively, you can create a production build locally: