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 recipe for rendering Markdown and MDX content in an RSS feed #10317

Open
bholmesdev opened this issue Dec 9, 2024 · 1 comment
Open

Add recipe for rendering Markdown and MDX content in an RSS feed #10317

bholmesdev opened this issue Dec 9, 2024 · 1 comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. help wanted Issues looking for someone to run with them! recipe Best solved by creating a short how-to/example

Comments

@bholmesdev
Copy link
Contributor

📚 Subject area/topic

RSS, MDX

📋 Suggested page

https://docs.astro.build/en/recipes/

📋 General description or bullet points (if proposing new content)

Our MDX compiledContent discussion has been open for two years now. Users were mainly interested in this feature to render rich text content in their RSS feeds.

We discovered that the container API can finally address this use case. Chris did some legwork building an example with the container API, but it's fairly complex and difficult for new users to discover. We also got a recent follow-up that outlines an alternative solution due to issues in Chris' example.

I think this use case is common enough that we should create a recipe for it. Find the simplest option using today's APIs, and log any roadmap items to improve the container API if we find it necessary while writing the docs.

🖥️ Reproduction of code samples in StackBlitz

No response

@bholmesdev bholmesdev added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label Dec 9, 2024
@sarah11918
Copy link
Member

Would welcome a recipe, which (reminder) would need a proper structure around it to accomplish a specific task outlined in the recipe. Things like:

  • state a problem to solve/specific goal to accomplish (e.g. "Generating full-text RSS feeds from remote Markdown/MDX" not "general theory", explanation of how things work focusing on the end goal the user has (RSS feeds when the content is remote) vs the intermediate goal "rendering remote Markdown" because they might not be thinking of searching for one step in the process)
  • write an opinionated step-by-step example that achieves that goal, which you can do because you state prerequisites/assumptions and write something that someone can follow and it will actually work
  • show how to check that implementing it was successful

If someone would like to turn this into a recipe, we would happily take a PR! And I think it could also be helpful to include a "Community Resource" link to delucis/astro-blog-full-text-rss!

@sarah11918 sarah11918 added help wanted Issues looking for someone to run with them! recipe Best solved by creating a short how-to/example labels Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. help wanted Issues looking for someone to run with them! recipe Best solved by creating a short how-to/example
Projects
None yet
Development

No branches or pull requests

2 participants