mkdocs-rss-plugin icon indicating copy to clipboard operation
mkdocs-rss-plugin copied to clipboard

RSS plugin is throwing error with mkdocs-material blog

Open zerenxyz opened this issue 3 years ago • 4 comments

When I run the link via a RSS Validator and I get an error for the author name:

line 1, column 433: Invalid email address: zeren [help]

... Hello again world!</title> <author>zeren</author> <category>Bar</categor ...

and also description error like this:

line 1, column 676: Missing channel element: description [help]
... n 2022 00:00:00 +0000</pubDate> </item> </channel></rss>

My mkdocs.yml file:

site_name: My Docs
theme:
  name: material

plugins:
  - blog:
      enabled: true
      blog_dir: blog/
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags

nav:
  - Blog:
    - blog/index.md

Example the a post:

---
draft: false
date: 2022-01-31
categories:
    - General
tags:
  - Foo
  - Bar
authors:
  - "zeren"
---

# Hello again world!


Helloooo!

my .author.yml file in blog/

zeren:
  name: zeren
  description: Testing
  avatar: http://placekitten.com/300/300

Direct link to github pages test: https://zerenxyz.github.io/testing-mkdocs/blog/

zerenxyz avatar Nov 29 '22 10:11 zerenxyz

Hello,

Thanks for your interest and taking time to reach me here.

When I run the link via a RSS Validator and I get an error for the author name:

As mentioned in the documentation: to comply with the standard, the page writer is responsible to fill this field following this syntax: [email protected] (John Doe) (read this SO).

and also description error like this:

As mentioned in the documentation, the site_description in mkdocs.yml is required for the RSS channel.

Guts avatar Dec 02 '22 09:12 Guts

As mentioned in the documentation: to comply with the standard, the page writer is responsible to fill this field following this syntax: [email protected] (John Doe) (read this SO).

So do I add a email: [email protected] to the .authors.yml file? To fix the issue of the email part? Or how can I add it? I am little confused in terms of how to make it work with MkDocs Material

zerenxyz avatar Dec 05 '22 10:12 zerenxyz

I have added the name of authors as you mentioned in the following format: [email protected] (John Doe) and the rss validator is coming back clean, however it still doesnt seem to work properly with IFTTT as the RSS Feed url says is invalid on there

zerenxyz avatar Dec 05 '22 12:12 zerenxyz

Sorry, I missed this answer.

and the rss validator is coming back clean

Good news!

however it still doesnt seem to work properly with IFTTT as the RSS Feed url says is invalid on there

Well, may the IFTTT RSS parser is not compliant? I think it's an upstream issue.

Guts avatar Apr 15 '23 06:04 Guts

No feedback for 1+ year. I close here.

Guts avatar Jun 09 '24 12:06 Guts