fix(blog): remove duplicate RSS feed and add JSON feed #15890
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
According to https://guts.github.io/mkdocs-rss-plugin/integrations/#automatically-set-with-material-theme, the RSS feed is automatically referenced by the Material theme's blog plugin. Since its version 1.12, the plugin proposes the JSON feed in addition to the RSS. Not so well known as its XML alternative, it's handled by numerous feed readers and JSON is generally lived as more readable. Disclaimer: I'm the maintainer of the RSS plugin.
miketheman
changed the title
|
Thanks for this - we also set a link to the feed in the footer here: warehouse/docs/mkdocs-blog.yml Lines 81 to 82 in 8c51e0a Would that need to change as well? |
No, the social hyperlinks in the footer are completely manual and do not interfere with the HTML templates. |
miketheman
approved these changes
May 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
According to https://guts.github.io/mkdocs-rss-plugin/integrations/#automatically-set-with-material-theme, the RSS feed is automatically referenced by the Material theme's blog plugin. So, the actual manual integration make it duplicated:
Otherwise, since its version 1.12, the plugin proposes the JSON feed in addition to the RSS. Not so well known as its XML alternative, it's handled by numerous feed readers and JSON is generally lived as more readable.
Disclaimer: I'm the maintainer of the RSS plugin.
Related previous PR: #14105 by @miketheman