Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configuration mismatch between site_author and managingEditor #192

Open
martinbira opened this issue May 29, 2023 · 0 comments
Open

Configuration mismatch between site_author and managingEditor #192

martinbira opened this issue May 29, 2023 · 0 comments

Comments

@martinbira
Copy link

martinbira commented May 29, 2023

The MkDocs configuration for site_author is corresponding to the managingEditor element according to the plugin documentation. However, the site_author populates the HTML meta tag, <meta name="author" content="Author Name">, and expects a name while the <managingEditor>-element expects an e-mail adress. This results in an invalid XML-file according to the W3C valdiator which in turn seems to not be processesed by some RSS readers.

Steps to reproduce

  1. Create a basic MkDocs-site using with the mkdocs-rss-plugin.
  2. Add site_author in the MkDocs configuration using a name and not an e-mail.
  3. Do not use any other page meta author information.
  4. Validate generated XML file with the W3C validator.

Suggestion
Provide an override for managingEditor in the plugin configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant