Pular para o conteúdo

Adicione um feed RSS

Astro suporta geração rápida e automática de feeds RSS para blogs e outros websites orientados a conteúdo. Feeds RSS fornecem uma forma fácil para usuários se inscreverem ao seu conteúdo.

Configurando @astrojs/rss

Seção intitulada Configurando @astrojs/rss

O pacote @astrojs/rss fornece utilitários para a geração de feeds RSS utilizando endpoints de API. Isso permite builds estáticas e geração sob demanda quando você estiver utilizando um adaptador de SSR.

  1. Instale @astrojs/rss utilizando seu gerenciador de pacotes favorito:
Terminal window
npm install @astrojs/rss
  1. Crie um arquivo em src/pages/ com o nome que preferir e a extensão .xml.js para ser usado como a URL final do seu feed. Algumas URLs comuns para feed RSS são feed.xml ou rss.xml.

O arquivo de exemplo abaixo src/pages/rss.xml.js vai criar um feed RSS em site/rss.xml.

  1. Importe o utilitário rss() do pacote @astrojs/rss para o seu arquivo .xml.js e exporte uma função que retorne ele usando os seguintes parâmetros:
src/pages/rss.xml.js
import rss from '@astrojs/rss';


export function GET(context) {
  return rss({
    // campo `<title>` no xml final
    title: 'Blog do Buzz',
    // campo `<description>` no xml final
    description: 'O guia de um humilde Astronauta para as estrelas',
    // Pega o "site" do seu projeto do contexto do endpoint
    // https://docs.astro.build/pt-br/reference/api-reference/#contextsite
    site: context.site,
    // Array de `<item>`s no xml final
    // Veja a seção "Gerando items" para exemplos utilizando coleções de conteúdo e importações de glob
    items: [],
    // (opcional) injeta xml customizado
    customData: `<language>pt-BR</language>`,
  });
}

Gerando items

Seção intitulada Gerando items

O campo items aceita uma lista de objetos de feed RSS, cada um com um link, title e pubDate obrigatórios. Três valores opcionais também podem ser inclusos de description (um pequeno resumo), content (o conteúdo completo da sua postagem) e o campo customData para incluir qualquer dado extra, como outras propriedades do frontmatter da suas postagens do blog.

Você pode gerar esse array a partir de uma esquema de coleção de conteúdo ou utilizando importações de glob para postagens de blog localizados dentro do src/pages/.

Utilizando coleções de conteúdo

Seção intitulada Utilizando coleções de conteúdo

Para criar um feed RSS de páginas gerenciadas em coleções de conteúdo, utilize a função getCollection() para pegar a lista de seus itens.

src/pages/rss.xml.js
import rss from '@astrojs/rss';
import { getCollection } from 'astro:content';


export async function GET(context) {
  const blog = await getCollection('blog');
  return rss({
    title: 'Blog do Buzz',
    description: 'O guia de um humilde Astronauta para as estrelas',
    site: context.site,
    items: blog.map((postagem) => ({
      title: postagem.data.titulo,
      pubDate: postagem.data.dataPub,
      description: postagem.data.descricao,
      customData: postagem.data.dadosCustom,
      // Computa o link RSS a partir da `slug` da postagem
      // Este exemplo assume que todas as postagens são renderizadas como rotas `/blog/[slug]`
      link: `/blog/${post.slug}/`,
    })),
  });
}

Opcional: substitua seus esquemas de coleções do blog para garantir essas propriedades de RSS esperadas.

Para garantir que cada entrada da coleção produz um item válido no feed RSS, você pode opcionalmente importar e aplicar rssSchema ao invés de definir cada propriedade individual do seu esquema.

src/content/config.ts
import { defineCollection } from 'astro:content';
import { rssSchema } from '@astrojs/rss';


const blog = defineCollection({
  schema: rssSchema,
});


export const collections = { blog };

Utilizando importações de glob

Seção intitulada Utilizando importações de glob
Adicionado em: @astrojs/rss@2.1.0

Para criar um feed RSS a partir de documentos em src/pages/, utilize o utilitário pagesGlobToRssItems(). Ele aceita um resultado de import.meta.glob e devolve um array de itens de feed RSS válidos (veja mais sobre como escrever padrões de glob para especificar quais páginas incluir).

src/pages/rss.xml.js
import rss, { pagesGlobToRssItems } from '@astrojs/rss';


export async function GET(context) {
  return rss({
    title: 'Blog do Buzz',
    description: 'O guia de um humilde Astronauta para as estrelas',
    site: context.site,
    items: await pagesGlobToRssItems(
      import.meta.glob('./blog/*.{md,mdx}'),
    ),
  });
}

Incluindo conteúdo completo de postagem

Seção intitulada Incluindo conteúdo completo de postagem
Adicionado em: astro@1.6.14

A chave content contém o conteúdo completo da postagem como HTML. Isso te permite fazer o conteúdo da sua postagem inteira disponível a leitores de feeds RSS.

Ao utilizar coleções de conteúdo, renderize o body da postagem utilizando um parser padrão de Markdown como markdown-it e sanitize o resultado:

src/pages/rss.xml.js
import rss from '@astrojs/rss';
import { getCollection } from 'astro:content';
import sanitizeHtml from 'sanitize-html';
import MarkdownIt from 'markdown-it';
const parser = new MarkdownIt();


export async function GET(context) {
  const blog = await getCollection('blog');
  return rss({
    title: 'Blog do Buzz',
    description: 'O guia de um humilde Astronauta para as estrelas',
    site: context.site,
    items: blog.map((postagem) => ({
      link: `/blog/${postagem.slug}/`,
      // Nota: isso não irá processar componentes ou expressões JSX em arquivos MDX.
      content: sanitizeHtml(parser.render(postagem.body)),
      ...postagem.data,
    })),
  });
}

Ao utilizar importações de glob com Markdown, você pode utilizar o utilitário compiledContent() para pegar o HTML renderizado para sanitização. Nota: essa funcionalidade não é suportada para arquivos MDX.

src/pages/rss.xml.js
import rss from '@astrojs/rss';
import sanitizeHtml from 'sanitize-html';


export function GET(context) {
  const resultadoImportacaoPostagem = import.meta.glob('../postagens/**/*.md', { eager: true });
  const postagens = Object.values(resultadoImportacaoPostagem);
  return rss({
    title: 'Blog do Buzz',
    description: 'O guia de um humilde Astronauta para as estrelas',
    site: context.site,
    items: postagens.map((postagem) => ({
      link: postagem.url,
      content: sanitizeHtml(postagem.compiledContent()),
      ...postagem.frontmatter,
    })),
  });
}

Adicionando uma folha de estilos

Seção intitulada Adicionando uma folha de estilos

Estilize seu feed RSS para tornar a experiência do usuário mais agradável quando estiver visualizando o arquivo em seu navegador.

Utilize a opção stylesheet da função rss para especificar um caminho absoluto para sua folha de estilos.

rss({
  // ex. utiliza sua folha de estilos de "public/rss/styles.xsl"
  stylesheet: '/rss/styles.xsl',
  // ...
});

Próximos Passos

Seção intitulada Próximos Passos

Após visitar seu feed no navegador em seu-dominio.com.br/rss.xml e confirmar que você consegue ver os dados das suas postagens, você pode agora promover seu feed em seu website. Adicionando o ícone RSS padrão em seu site permite que seus leitores saibam que eles podem se inscrever para suas postagens no próprio leitor de feed que preferirem.

Resources

Seção intitulada Resources