Skip to content

Commit

Permalink
Add tutorial link
Browse files Browse the repository at this point in the history
  • Loading branch information
runeb authored Aug 9, 2023
1 parent 21d88c9 commit b5b8a77
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions packages/sanity-astro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ npx astro add @sanity/astro

## Usage in Astro

Configure the integration in your `astro.config.mjs` file. The configuration options are the same as for @sanity/client.
Configure the integration in your `astro.config.mjs` file. The configuration options are the same as for [@sanity/client](https://github.com/sanity-io/client#readme).

```typescript
import sanity from "@sanity/astro";
Expand All @@ -32,8 +32,11 @@ export default defineConfig({

## PortableText

We recommend using [astro-portabletext](https://github.com/theisel/astro-portabletext) to render your PortableText fields in Astro. See an example of this in apps/example/src/components/PortableText.astro, including using custom components to render custom blocks and annotations.
We recommend using [astro-portabletext](https://github.com/theisel/astro-portabletext) to render your PortableText fields in Astro. See an example of this in [apps/example/src/components/PortableText.astro](../../apps/example/src/components/PortableText.astro), including using custom components to render custom blocks and annotations.

## Presenting images

We recommend using [@sanity/image-url](https://www.sanity.io/docs/image-url) to help you generate URLs for presenting Sanity images in your Astro app. See an example of this in apps/example/src/components/SanityImage.astro
We recommend using [@sanity/image-url](https://www.sanity.io/docs/image-url) to help you generate URLs for presenting Sanity images in your Astro app. See an example of this in [apps/example/src/components/SanityImage.astro](../../apps/example/src/components/SanityImage.astro)

### Learning
Please see our [guided tutorial](https://www.sanity.io/guides/sanity-astro-blog) on how to create a blog with Sanity content in Astro to get started from scratch with both Sanity and Astro.

1 comment on commit b5b8a77

@vercel
Copy link

@vercel vercel bot commented on b5b8a77 Aug 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

sanity-astro-example-ssr – ./apps/example-ssr

sanity-astro-example-ssr.sanity.build
sanity-astro-example-ssr-git-main.sanity.build

Please sign in to comment.