@nuxtjs/feed

Feed module - Everyone deserves RSS, Atom and Json

📖 Release Notes

Features

• Three different feed types (RSS 2.0, ATOM 1.0 and JSON 1.0)
• As many feeds as you like!
• Completely customizable. Need to fetch data before? No problem!
• Works with all modes (yes, even generate!)

Setup

• Add @nuxtjs/feed dependency using yarn or npm to your project
• Add @nuxtjs/feed to modules section of nuxt.config.js

{
  modules: [
    // Simple usage
    '@nuxtjs/feed',
 ],
 feed: [
   // Your feeds here
 ]
}

• Configure it as you need

Configuration

So.. how to get these feeds working now?

Configuration object overview

{
 //...
 feed: [
   // A default feed configuration object
   {
     path: '/feed.xml', // The route to your feed.
     async create (feed) {}, // The create function (see below)
     cacheTime: 1000 * 60 * 15, // How long should the feed be cached
     type: 'rss2' // Can be: rss2, atom1, json1
   }
 ],
 //...
}

Feed create function

Let's take a closer look on the create function. This is the API that actually modifies your upcoming feed.

A simple create function could look like this:

create = async feed => {
  feed.options = {
    title: 'My blog',
    description: 'This is my personal feed!',
  }
  
  const posts = await axios.get('https://blog.lichter.io/posts/').data
  posts.forEach(post => { 
    feed.addItem({
        title: post.title,
        id: post.url,
        link: post.url,
        description: post.description,
        content: post.content
  })
  
  feed.addCategory('Nuxt.js')
  
  feed.addContributor({
    name: 'Alexander Lichter',
    email: '[e-mail]',
    link: 'https://lichter.io/'
  })
}

Feed creation is based on the feed package. Please use it as reference and further documentation for modifying the feed object that is passed to the create function.

Using the create function gives you unlimited possibilities to customize your feed!

Development

• Clone this repository
• Install dependencies using yarn install or npm install
• Start development server using npm run dev

License

MIT License

Copyright (c) Alexander Lichter