Skip to content

Commit

Permalink
Integration README fixes (#3865)
Browse files Browse the repository at this point in the history
* Remove stray XML tag in sitemap integration README

* Fix link errors

* Add changeset
  • Loading branch information
delucis authored Jul 8, 2022
1 parent 70b0246 commit 1f9e485
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 8 deletions.
11 changes: 11 additions & 0 deletions .changeset/breezy-ravens-sort.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/integrations/deno/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions packages/integrations/netlify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion packages/integrations/prefetch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
- <strong>[Examples](#examples)</strong>
- <strong>[Troubleshooting](#troubleshooting)</strong>
- <strong>[Contributing](#contributing)</strong>
- <strong>[Changelog](#changelog)</strong>

## Why Prefetch?

Expand Down
1 change: 0 additions & 1 deletion packages/integrations/sitemap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"?>
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/vercel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 1f9e485

Please sign in to comment.