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

Update plugins.md adding remark-callouts and remark-wiki-link-plus #1406

Closed
wants to merge 1 commit into from

Conversation

rufuspollock
Copy link

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything or linked relevant results below
  • I made sure the docs are up to date
  • I included tests (or that’s not needed)

Description of changes

Update plugins.md adding remark-callouts and remark-wiki-link-plus

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Feb 10, 2025
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

Hi!

CI is failing :)

Looks like the latter is deprecated? Both seem not really maintained?

I also see a .use(markdown, { gfm: true }), I don’t believe that option exists, it used to be there years and years ago.

For the callouts, that has more to do with HTML than with markdown. That’s where rehype comes in, instead of remark. Solutions like https://github.com/rehypejs/rehype-github/tree/main/packages/alert and https://github.com/chrisweb/rehype-github-alerts are good examples of that

@rufuspollock
Copy link
Author

Looks like the latter is deprecated? Both seem not really maintained?

We actively maintain them - we just need to migrate some of the material back from the monorepo we created. We'll do that and update here.

I also see a .use(markdown, { gfm: true }), I don’t believe that option exists, it used to be there years and years ago.

We'll also remove that.

For the callouts, that has more to do with HTML than with markdown. That’s where rehype comes in, instead of remark. Solutions like https://github.com/rehypejs/rehype-github/tree/main/packages/alert and https://github.com/chrisweb/rehype-github-alerts are good examples of that

Ok, that's good to know and we'll look at that.

🙏 thank-you for prompt and clear response (as an open source maintainers ourselves we appreciate the time and effort!)

@wooorm
Copy link
Member

wooorm commented Feb 20, 2025

OK, well, no rush. I’ll close this for now then; you can reopen when you merge things back from the monorepo into separate things. Though, this list can have packages in monorepos, so that migration is not needed for this list.

This list is for plugins that we recommend to users. So that means running tests in CI and lots of tests and extensive docs and such!

Feel free to ask a maintainer here if you want someone to look through your code.
In many cases, we also recommend rehype plugins instead of remark plugins.

@wooorm wooorm closed this Feb 20, 2025
@wooorm wooorm added the 🙅 no/wontfix This is not (enough of) an issue for this project label Feb 20, 2025

This comment has been minimized.

@github-actions github-actions bot added 👎 phase/no Post cannot or will not be acted on and removed 🤞 phase/open Post is being triaged manually labels Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🙅 no/wontfix This is not (enough of) an issue for this project 👎 phase/no Post cannot or will not be acted on
Development

Successfully merging this pull request may close these issues.

2 participants