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

Wrong instructions for rehype plugins #4549

Closed
offbit-it opened this issue Sep 5, 2023 · 1 comment · Fixed by withastro/astro#8733
Closed

Wrong instructions for rehype plugins #4549

offbit-it opened this issue Sep 5, 2023 · 1 comment · Fixed by withastro/astro#8733
Labels
good first issue Good for newcomers help wanted Issues looking for someone to run with them!

Comments

@offbit-it
Copy link

📝 Issue Description

Hey guys,

I would like to report a problem with documentation.
It is about markdown.rehypePlugins settings.

import rehypeMinifyHtml from 'rehype-minify';

This line is not valid anymore since there is no npm package called rehype-minify

📋 On which page(s) it occurs

https://docs.astro.build/en/reference/configuration-reference/#markdownrehypeplugins

🤔 Expected Behavior

The documentation should provide a working PoC code/configuration.

👀 Current Behavior

The configuration of documentation doesn't work since there is no package called rehype-minify

🖥️ Browser

Chrome X

📄 Additional Information

No response

@offbit-it offbit-it added the bug Something on the site isn't working label Sep 5, 2023
@sarah11918 sarah11918 added help wanted Issues looking for someone to run with them! good first issue Good for newcomers and removed bug Something on the site isn't working labels Sep 17, 2023
@sarah11918
Copy link
Member

Thanks for spotting this and pointing it out @kristijan97 ! We did update our docs content on the Markdown/MDX page when this was discovered before ( https://docs.astro.build/en/guides/markdown-content/#markdown-plugins ), but it looks like we did not also update the code example on the configuration reference page!

This issue would require a PR to the main astro repo at this location: https://github.com/withastro/astro/blob/fca6892f8d6a30ceb1e04213be2414dd4cb4d389/packages/astro/src/%40types/astro.ts#L1169

The example could be updated to show any valid rehype plugin, as we have done on the Markdown page.

Labelling this as help wanted so anyone can feel free to make this update! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Issues looking for someone to run with them!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants