Documentation advises against using remark/rehype, but markdown example includes such plugins about docs HOT 3 CLOSED

Hi @Because789!

The two things here are actually distinct, but maybe we don’t make that clear enough:

• The with-markdown-plugins example shows using remark/rehype to transform your Markdown content with several plugins

• The caution in the docs you linked to is related specifically to using remark/rehype to transform your Markdown frontmatter

While we don’t recommend modifying frontmatter like this, modifying content is safe and something many Astro sites do, including the Astro docs.

from docs.

Hey @delucis, thanks for your answer, now I understand. Obviously, I didn't check how the plugins in with-markdown-plugins are actually used. I just saw rehype-slug and thought, that it probably does something with the frontmatter slug.

I think what tripped me off was, that the caution box sounds like ALL the remark and rehype plugins are dangerous: "Remark and rehype plugins access the raw Markdown or MDX document frontmatter." That sounds pretty absolute, I feel like this could be improved. No idea how though, I'm simply not familiar enough with these plugins.

from docs.

Thanks for this comment! I will be revising our content pages (markdown, MDX, Markdoc and Content Collections) in the next little while and will take this under advisement to make sure we are clear in our recommendations.

from docs.