Skip to content

Conversation

paul-sachs
Copy link

Description

Only built in loaders (file and glob) support built in markdown parsing. Since content collections now allow defining remote collections, this link is misleading.

Only built in loaders (file and glob) support built in markdown parsing. Since content collections now allow defining remote collections, this link is misleading.
Copy link

netlify bot commented Sep 18, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 7cee2a2
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/68cc07e96b95c5000821eb24
😎 Deploy Preview https://deploy-preview-12335--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@astrobot-houston
Copy link
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/markdown-content.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@astrobot-houston
Copy link
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@sarah11918 sarah11918 added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Sep 18, 2025
@sarah11918
Copy link
Member

Thank you for this PR @paul-sachs ! We've been tracking down the specific support for Markdown in content collections, and I believe this phrase was added when we introduced renderMarkdown in the Content Loader API... but I think our original framing of built-in isn't really helpful here:

Yes, renderMarkdown is "built in" to Astro, but so that you can build your own custom loader, and that doesn't exactly feel super built-in to readers, I think! 😅

So I think this phrasing needs a rewrite itself to discuss what is available/supported re: remote Markdown, and I think we should do away with saying "built in" and just be more explicit about the possibilities.

Would you like to try writing something here that expresses more clearly that there is a parser for remote Markdown to help you build a custom loader for content collections, but otherwise you will need to handle parsing remote Markdown yourself? We can workshop it together! Do you have any thoughts on making this more helpful?

@paul-sachs
Copy link
Author

@sarah11918 I can give it a try when I get some time though it'll take me some time to figure out exactly what we should say here.

I think my primary concern was making it obvious that the renderMarkdown function provided to custom content loaders does not support using the default markdown settings (using Astro.config markdown settings.) I'm actually not sure if that section really belongs here so much as perhaps an example showing how we might mimic that behaviour (as described in withastro/roadmap#1094)

@sarah11918
Copy link
Member

Thanks @paul-sachs and for sure did not mean to put this on you! It may very well be that removing the link as you initially proposed is the right move here. Just wanted to check to see whether you had thoughts on this! We'll be working on this one too 😄

Comment on lines +400 to 402
Astro does not include built-in support for remote Markdown.

To fetch remote Markdown directly and render it to HTML, you will need to install and configure your own Markdown parser from NPM. This will not inherit from any of Astro's built-in Markdown settings that you have configured.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Astro does not include built-in support for remote Markdown.
To fetch remote Markdown directly and render it to HTML, you will need to install and configure your own Markdown parser from NPM. This will not inherit from any of Astro's built-in Markdown settings that you have configured.
Astro's internal Markdown processor is not available for processing remote Markdown.
To fetch remote Markdown for use in [content collections](/en/guides/content-collections), you can [build a custom loader](/en/guides/content-collections/#building-a-custom-loader) with access to a [`renderMarkdown()` function](/en/reference/content-loader-reference/#rendermarkdown).
To fetch remote Markdown directly and render it to HTML, you will need to install and configure your own Markdown parser from NPM. This will not inherit from any of Astro's built-in Markdown settings that you have configured.

OK, might have gone link-happy here, but what do we think about something like this @paul-sachs ? (Until such time as we actually do expose the internal Markdown parser?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants