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

Add rehype-scroll-to-top, rehype-smenatic-images to list of plugins #163

Merged
merged 4 commits into from
Feb 6, 2024

Conversation

benjamincharity
Copy link
Contributor

Add new 'scroll to top' plugin

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 a new Rehype plugin to the plugins doc. rehype-scroll-to-top.

Add new 'scroll to top' plugin
@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 3, 2024
Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

Thanks for sharing @benjamincharity! 🙇
Always happy to have new plugins in the community!

A few suggestions, for this PR could you look into

doc/plugins.md
  173:20-173:21  warning  Expected a smart quote: `“`, not `"`  quote                retext-quotes
  173:34-173:35  warning  Expected a smart quote: `”`, not `"`  quote                retext-quotes
  173:40-173:41  warning  Expected a smart quote: `“`, not `"`  quote                retext-quotes
  173:57-173:58  warning  Expected a smart quote: `”`, not `"`  quote                retext-quotes
         173:86  warning  Line must be at most 80 characters    maximum-line-length  remark-lint

For the code base itself, some suggestions:

@benjamincharity
Copy link
Contributor Author

I am new to the rehype ecosystem, and this is my first rehype plug-in, so I appreciate the detailed response! I will look into these today.

@benjamincharity
Copy link
Contributor Author

@ChristianMurphy I have released a new version of my plugin that addresses all of the listed issues (v0.1.5) and have updated this PR to address the line length and incorrect quote type.

I am seeing failures in the actions that seem unrelated to my changes. Please let me know if there is anything else I should adjust.

Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

Thanks @benjamincharity!
Looks good, could you put rehype-semantic-images in alpha order in this list? Then this looks good.
Don't worry about the XO error for this PR it's unrelated.
But if you have time you're welcome to look into it in another PR, contributions are always welcome! 🙂

Optional suggestions:

doc/plugins.md Outdated Show resolved Hide resolved
Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @benjamincharity!
Same optional comments from #163 (review) still apply, but aren't a blocker for adding this to the docs.

@wooorm wooorm changed the title Update plugins.md Add rehype-scroll-to-top, rehype-smenatic-images to list of plugins Feb 6, 2024
@wooorm wooorm merged commit 6849661 into rehypejs:main Feb 6, 2024
0 of 2 checks passed
@wooorm wooorm added 📚 area/docs This affects documentation 💪 phase/solved Post is done labels Feb 6, 2024

This comment has been minimized.

@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Feb 6, 2024
@wooorm
Copy link
Member

wooorm commented Feb 6, 2024

Thanks Benjamin!

@benjamincharity benjamincharity deleted the add-new-rehype-plugin branch February 6, 2024 21:36
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.

4 participants