Add remark-github-blockquote-alert to list of plugins

[jaywcjlove]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)
• If applicable, I’ve added docs and tests

Description of changes

Add remark-github-blockquote-alert

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d0886dc) to head (ca34563).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #1298   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          142       142           
=========================================
  Hits           142       142           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ChristianMurphy]

Hey @jaywcjlove!
Thanks for sharing!

This appears to focus on the HTML output and does not modify the markdown?
If so you may want to consider a rehype plugin instead.

There is one https://github.com/chrisweb/rehype-github-alerts which may suit your needs.
There is also an open issue on rehypejs/rehype-github#3 which could standardize this if needed.

[jaywcjlove]

@ChristianMurphy Oh, I didn't pay attention to it.

[wooorm]

remark-github-beta-blockquote-admonitions is listed already too.
And indeed, perhaps better to do this in HTML/rehype, chrisweb/rehype-github-alerts?

What should we do with this PR? @jaywcjlove @ChristianMurphy?

[jaywcjlove]

Both remark-github-beta-blockquote-admonitions and rehype-github-alerts have historical baggage, supporting old syntax, which should now be removable.

remark-github-beta-blockquote-admonitions does not generate icons, so you need to add icons manually through CSS.

Therefore, I think rehype-github-alerts is better.

remark-github-blockquote-alert did not implement the old syntax and instead expanded with a new syntax for internationalization, as follows:

> [!NOTE/笔记]  
> Useful information that users should know, even when skimming content.

@wooorm So I should only use my own remark-github-blockquote-alert.

@wooorm @ChristianMurphy I forgot to ask if merging another option would be possible. If not needed, I will close it.

[wooorm]

To summarize, you are saying:

• remark-github-beta-blockquote-admonitions is not really maintained
• rehype-github-alerts is maintained but also includes code for an older syntax.

remark-github-blockquote-alert

I do wonder about what Christian also asked: would a rehype plugin not be better?

And if you’d make it a rehype plugin, then it would be almost the existing rehype-github-alerts. Is it really worth it to have 2 plugins?

[jaywcjlove]

When I was developing this plugin, I was only aiming to solve the issue in my other package uiwjs/react-markdown-preview#258, and added an internationalization option for another project of mine. I didn't pay attention to rehype-github-alerts at that time. Now it has been integrated into multiple projects of mine, remark-github-blockquote-alert has completed its mission on my side.

If rehype-github-alerts removes support for the old syntax and supports the special syntax I want, > [!NOTE/笔记], I am willing to abandon my project.

@wooorm

[wooorm]

remark-github-blockquote-alert has completed its mission on my side.

That sounds like you are not interested in maintaining your project? 🤔

the special syntax I want,

🤔 That sounds like your project does not match GitHub? It matches GH in some ways, but also matches your own preferences?

[jaywcjlove]

remark-github-blockquote-alert has completed its mission on my side.

That sounds like you are not interested in maintaining your project? 🤔

the special syntax I want,

🤔 That sounds like your project does not match GitHub? It matches GH in some ways, but also matches your own preferences?

I have contributed to nearly 300 code repositories in the open-source community and published over 500 packages through npm. However, things have been tough lately. I lost my job at the end of last year, and I currently have no income and haven't managed to overcome this situation yet. Recently, someone raised a new issue (#258) in a project, and I noticed that the needed plugins were not listed in the remark and rehype projects. However, I found the solution to this problem to be quite simple, so I started developing a new package to address it.

I have contributed 4 plugins to rehype and have been actively maintaining them. I simply feel that if there are two similar plugins, the official preference is to keep only one, and I am willing to abandon my own.

@wooorm

[wooorm]

I have contributed to nearly 300 code repositories in the open-source community and published over 500 packages through npm.

Yes, I know you’re prolific and contribute a lot! 😊 I appreciate it!

However, things have been tough lately. I lost my job at the end of last year, and I currently have no income and haven't managed to overcome this situation yet.

I am sorry to hear that!

I have contributed 4 plugins to rehype and have been actively maintaining them. I simply feel that if there are two similar plugins, the official preference is to keep only one, and I am willing to abandon my own.

Right, good point.

---

I am fine adding this for now. If it becomes unmaintained, or people have problems with the mistmatch between what it does and what they think it does, we can revisit this later!