{"library":"mkdocs-rss-plugin","title":"MkDocs RSS Plugin","description":"mkdocs-rss-plugin is an MkDocs plugin that generates RSS and JSON feeds for your documentation site. It leverages your MkDocs site configuration, Git log for commit metadata, and page frontmatter to create rich feed entries. Currently at version 1.18.1, it receives frequent minor updates to improve features, fix bugs, and enhance compatibility with other MkDocs plugins like Material for MkDocs blog.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install mkdocs-rss-plugin"],"cli":null},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"mkdocs.yml:\n  site_name: My Awesome Docs\n  site_url: https://example.com/\n\n  plugins:\n    - rss:\n        feed_url: feed.xml\n        json_feed_url: feed.json\n        feed_item_description: true\n        categories:\n          - blog\n\ndocs/index.md:\n  # Home page content\n\ndocs/blog/post1.md:\n  ---\n  title: My First Blog Post\n  date: 2024-01-15\n  author: John Doe\n  ---\n  This is the content of my first blog post.\n\n# To build the site and generate feeds:\n# mkdocs build\n# To serve the site locally and see the feeds:\n# mkdocs serve\n\n# After running 'mkdocs build', feed.xml and feed.json will be in your site_dir (default: 'site/')","lang":"yaml","description":"To enable the mkdocs-rss-plugin, you need to add it to the `plugins` section of your `mkdocs.yml` configuration file. This example sets up basic RSS and JSON feeds, and configures the plugin to include full page descriptions and filter items from a 'blog' category based on page paths.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}