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 explanation on @daiji256/rehype-mathml in plugins.md #189

Merged
merged 3 commits into from
Feb 20, 2025

Conversation

tats-u
Copy link
Contributor

@tats-u tats-u commented Feb 16, 2025

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

The current explanation on @daiji256/rehype-mathml has the following problems:

  • Readers can misunderstand the package name to be passed to npm i
  • Readers who are searching a plugin for Temml cannot find it

@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 16, 2025
Copy link

codecov bot commented Feb 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9bc5528) to head (77c8ab9).
Report is 25 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #189   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          154       163    +9     
=========================================
+ Hits           154       163    +9     

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

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.

I am not sure about adding the scope name.

This list current goal is not to be a list of npm package names. It’s a list of plugin names.

Co-authored-by: Titus <[email protected]>
Signed-off-by: Tatsunori Uchino <[email protected]>
@Daiji256
Copy link
Contributor

Readers can misunderstand the package name to be passed to npm i

I decided to list it without a scope, consistent with other libraries such as @mapbox/rehype-prism, @benjc/rehype-scroll-to-top, and @hbsnow/rehype-sectionize.

@tats-u
Copy link
Contributor Author

tats-u commented Feb 19, 2025

I forgot to revert addition of the namespace. Thank you for your notification.

@tats-u
Copy link
Contributor Author

tats-u commented Feb 19, 2025

If other than Squash and Merge is going to be applied here, I will squash these 3 commits in one in advance. Please tell me so before merging or rebasing.

@wooorm
Copy link
Member

wooorm commented Feb 20, 2025

I always squash! :) Thank you!

@wooorm wooorm merged commit a816999 into rehypejs:main Feb 20, 2025
4 checks passed
@wooorm wooorm added 📚 area/docs This affects documentation 💪 phase/solved Post is done labels Feb 20, 2025

This comment has been minimized.

@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Feb 20, 2025
@tats-u

This comment was marked as outdated.

@tats-u
Copy link
Contributor Author

tats-u commented Feb 20, 2025

Thank you for merging.

@tats-u tats-u deleted the patch-1 branch February 20, 2025 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done
Development

Successfully merging this pull request may close these issues.

3 participants