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

Add RSS plugin and feed link #99

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mickelsonmichael
Copy link

@mickelsonmichael mickelsonmichael commented Jan 9, 2025

Resolves #59

Was recommended your blog and wanted to subscribe via RSS, and the plugin seemed simple enough to implement so figured I'd contribute.

XML documents representing the feed should be generated at build time (one for updates one for creations), and the link at the bottom should link to the creation version (feed_rss_created.xml).

Let me know if any additional changes are necessary, and thank you!


Important

Add RSS plugin to MkDocs and link to RSS feed in social links.

  • Plugins:
    • Add rss plugin to mkdocs.yml to generate RSS feeds.
    • Update requirements-doc.txt to include mkdocs-rss-plugin.
  • Social Links:
    • Add RSS feed link (feed_rss_created.xml) to social links in mkdocs.yml.

This description was created by Ellipsis for 6e85145. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to 6e85145 in 10 seconds

More details
  • Looked at 32 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. mkdocs.yml:157
  • Draft comment:
    The RSS feed link should be an absolute URL to ensure it works correctly across different contexts. Consider updating it to an absolute URL.
  • Reason this comment was not posted:
    Confidence changes required: 80%
    The PR adds the RSS plugin to the mkdocs configuration and the requirements file. However, the link to the RSS feed in the social section should be an absolute URL to ensure it works correctly.
2. requirements-doc.txt:7
  • Draft comment:
    Ensure that the mkdocs-rss-plugin is correctly installed and compatible with the current setup.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The addition of the RSS plugin in the requirements file is correct and necessary for the functionality added in the PR.

Workflow ID: wflow_tpQX5bHkLNh6mGU7


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

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.

RSS for the blog
1 participant