plugin-rss

Gungnir
2020-03-26
2 min

npm github license

A plugin for adding RSS to VuePress theme Gungnir, forked from youngtailors/vuepress-plugin-rss.

WARNING

This plugin is only guaranted to work on VuePress theme Gungnir. It may not work on other themes.

# Install

yarn add @renovamen/vuepress-plugin-rss
# or
npm install @renovamen/vuepress-plugin-rss

# Configuration

Configurate it in your .vuepress/config.js:

module.exports = {
  plugins: [
    [
      '@renovamen/vuepress-plugin-rss', {
        site_url: "https://zxh.io",  // Site URL (required)
        copyright: "Renovamen 2018-2021",  // Copyright (optional)
        count: 20,  // How many articles to be shown on RSS (optional)
        filter: (frontmatter) => { return [true|false] },  // Post filter (optional)
      }
    ]
  ]
}

# License

MIT