$ cd /home/

plugin-rss

Gungnir
2020-03-26
3 min

npmgithublicense

A plugin for adding RSS to VuePress 2 theme Gungnir, adapted 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

pnpm install @renovamen/vuepress-plugin-rss@next

yarn add @renovamen/vuepress-plugin-rss@next

npm install @renovamen/vuepress-plugin-rss@next

Configuration

Configurate it in your .vuepress/config.js:

const { rssPlugin } = require("@renovamen/vuepress-plugin-rss");

module.exports = {
  plugins: [
    rssPlugin({
      siteURL: "https://zxh.io",  // site URL (required)
      title: "Renovamen's blog",  // site title (optional, default: `themeConfig.title`)
      description: "A blog powered by VuePress and Gungnir",  // site description (optional, default: "")
      copyright: "Renovamen 2018-2022",  // site copyright (optional, default: "")
      count: 20,  // number of posts to be generated (optional, default: 20)
      filter: (page) => true  // filter function to choose which posts to be generated (optional, default: (page) => true)
    })
  ]
}

License

MIT