Skip to content

on-demand rendering for experimental Live Content collections #11910

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.

Sign up for GitHub

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

Merged
sarah11918 merged 1 commit into from
Jun 19, 2025
Merged

on-demand rendering for experimental Live Content collections #11910

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion src/content/docs/en/reference/experimental-flags/live-content-collections.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Live content collections are a new type of [content collection](/en/guides/conte

## Basic usage

To enable the feature, add the `experimental.liveContentCollections` flag to your `astro.config.mjs` file:
To enable the feature, make sure you have an adapter configured for [on-demand rendering](/en/guides/on-demand-rendering/) and add the `experimental.liveContentCollections` flag to your `astro.config.mjs` file:

```js title="astro.config.mjs"
{
Expand Down Expand Up @@ -52,6 +52,8 @@ You can then use the dedicated `getLiveCollection()` and `getLiveEntry()` functi

```astro
---
export const prerender = false; // Not needed in 'server' mode

import { getLiveCollection, getLiveEntry } from 'astro:content';

// Get all products
Expand Down Expand Up @@ -126,6 +128,8 @@ You can then get content from both loaders with a unified API:

```astro
---
export const prerender = false; // Not needed in 'server' mode

import { getLiveCollection, getLiveEntry } from 'astro:content';

// Use loader-specific filters
Expand Down Expand Up @@ -155,6 +159,8 @@ These errors have a static `is()` method that you can use to check the type of e

```astro "LiveEntryNotFoundError.is(error)"
---
export const prerender = false; // Not needed in 'server' mode

import { getLiveEntry, LiveEntryNotFoundError } from 'astro:content';
const { entry, error } = await getLiveEntry('products', Astro.params.id);
if (error) {
Expand Down Expand Up @@ -281,6 +287,8 @@ You can then render both content and metadata from live collection entries in pa

```astro "render(entry)" "<Content />"
---
export const prerender = false; // Not needed in 'server' mode

import { getLiveEntry, render } from 'astro:content';
const { entry, error } = await getLiveEntry('articles', Astro.params.id);
if (error) {
Expand Down Expand Up @@ -350,6 +358,8 @@ When you use `getLiveCollection()` or `getLiveEntry()`, TypeScript will infer th

```astro
---
export const prerender = false; // Not needed in 'server' mode

import { getLiveEntry } from 'astro:content';
const { entry: product } = await getLiveEntry('products', '123');
// TypeScript knows product.data is of type Product
Expand Down Expand Up @@ -456,6 +466,8 @@ When you use `getLiveCollection()` or `getLiveEntry()`, TypeScript will infer th

```astro
---
export const prerender = false; // Not needed in 'server' mode

import { getLiveEntry } from 'astro:content';
const { entry, error } = await getLiveEntry('products', '123');
if (error) {
Expand Down Expand Up @@ -504,6 +516,8 @@ When using Zod schemas, validation errors are automatically caught and returned

```astro
---
export const prerender = false; // Not needed in 'server' mode

import { getLiveEntry, LiveCollectionValidationError } from 'astro:content';

const { entry, error } = await getLiveEntry('products', '123');
Expand Down Expand Up @@ -564,6 +578,8 @@ You can then use these hints in your pages:

```astro
---
export const prerender = false; // Not needed in 'server' mode

import { getLiveEntry } from 'astro:content';

const { entry, error, cacheHint } = await getLiveEntry('products', Astro.params.id);
Expand Down