Skip to content

chore(rss): use forked mkdocs-rss-plugin with validation fixes#73

Merged
Zerthick merged 1 commit into
mainfrom
chore/use-rss-plugin-fork
Jul 22, 2026
Merged

chore(rss): use forked mkdocs-rss-plugin with validation fixes#73
Zerthick merged 1 commit into
mainfrom
chore/use-rss-plugin-fork

Conversation

@Zerthick

Copy link
Copy Markdown
Collaborator

Summary

Switch to a forked copy of mkdocs-rss-plugin that includes RSS 2.0 validation fixes, eliminating the need for the fix_rss_template.py workaround script.

Changes

  • Dependency: Switch from mkdocs-rss-plugin>=1.17.1 to Zerthick/mkdocs-rss-plugin@fix/rss-validation-errors
  • Remove: fix_rss_template.py workaround script (124 lines deleted)
  • CI: Remove the RSS template patch step from the deploy workflow

Fixes included in the fork

Upstream PR: Guts/mkdocs-rss-plugin#451

  1. <author><dc:creator> — RSS 2.0 spec requires <author> to be an email address; switched to <dc:creator> for human-readable names
  2. Double-encoded HTML entities — Fixed &amp;amp;, &amp;lt;, &amp;gt; in title/description caused by MkDocs pre-escaping + Jinja |e filter
  3. Enclosure length guard — Skip <enclosure> when length is None/non-positive (handles remote image 404s)

Cleanup plan

Once the upstream PR merges, switch back to the official mkdocs-rss-plugin package and drop the fork reference.

- Switch to Zerthick/mkdocs-rss-plugin@fix/rss-validation-errors fork
  which includes upstream PR: Guts/mkdocs-rss-plugin#451
- Remove fix_rss_template.py workaround script (no longer needed)
- Remove RSS template patch step from CI workflow

Fixes included in fork:
- <author> -> <dc:creator> for RSS 2.0 compliance
- Guard enclosure length against None values
- Fix double-encoded HTML entities in title/description
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

Successfully merging this pull request may close these issues.

1 participant