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

remark-slug and remark-external-links are deprecated #21838

Closed
JReinhold opened this issue Mar 30, 2023 · 3 comments · Fixed by #25615
Closed

remark-slug and remark-external-links are deprecated #21838

JReinhold opened this issue Mar 30, 2023 · 3 comments · Fixed by #25615

Comments

@JReinhold
Copy link
Contributor

JReinhold commented Mar 30, 2023

We use two remark plugins to support our MDX functionality in addon-docs and builder-vite:

  1. remark-slug
  2. remark-external-links

Both of these plugins are marked as deprecated and the maintainer (who also maintains MDX) advices to switch to their rehype equivalent instead, rehype-slug and rehype-external-links.

If it doesn't produce any breaking changes, we should switch them over.

Additional context

remark-slug is used to automaticall add id to headings, which will create the link functionality to headings. That functionality should be preserved.

remark-external-links adds target="_blank" to all external links.

@JReinhold JReinhold changed the title Upgrade remark-slug and remark-external-links are deprecated remark-slug and remark-external-links are deprecated Mar 30, 2023
@MehakFatima24
Copy link

Hi, this is my first time contributing, is it okay if I take up this issue?

@MehakFatima24
Copy link

@JReinhold I have fixed the test cases, it would be extremely kind of you to take a look at this MR whenever its convenient. Dankjewel!

@chakAs3
Copy link
Contributor

chakAs3 commented Apr 1, 2023

I'm checking your PR @MehakFatima24 doing some tests. normally should work it is been legacy for 2 years now and they advice to switch to rehype

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment