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

Runtime - Added documentation for remarkPlugins #1218

Merged
merged 3 commits into from Oct 20, 2020
Merged

Conversation

dowi
Copy link
Contributor

@dowi dowi commented Aug 10, 2020

No description provided.

@vercel
Copy link

vercel bot commented Aug 10, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/mdx/mdx/akw1h3ah9
✅ Preview: https://mdx-git-fork-dowi-patch-1.mdx.vercel.app

@vercel vercel bot temporarily deployed to Preview August 10, 2020 19:27 Inactive
@ChristianMurphy ChristianMurphy added the 📚 area/docs This affects documentation label Aug 10, 2020
@ChristianMurphy ChristianMurphy requested a review from a team August 10, 2020 19:38
@vercel vercel bot temporarily deployed to Preview August 10, 2020 20:23 Inactive
@wooorm
Copy link
Member

wooorm commented Aug 11, 2020

This sounds like remarkPlugins is working with runtime, but it’s missing from the Props table? https://github.com/mdx-js/mdx/blob/7fefef74a07139a3ca034eef5c161c9797bd03b2/packages/runtime/readme.md#props. If so, it should be described in the table. And do rehypePlugins also work there?

I’m not sure about changing the example to include all potential uses. The example should be short. So I’d vote to not change the example.

@vercel vercel bot temporarily deployed to Preview August 24, 2020 17:52 Inactive
Copy link
Member

@johno johno left a comment

Choose a reason for hiding this comment

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

Thanks!

@johno johno merged commit 5608c5f into mdx-js:master Oct 20, 2020
wooorm pushed a commit that referenced this pull request Dec 17, 2020
* added documentation for remarkPlugins

* Update readme.md

* edit the properties table
wooorm pushed a commit that referenced this pull request Dec 17, 2020
* added documentation for remarkPlugins

* Update readme.md

* edit the properties table
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation
Development

Successfully merging this pull request may close these issues.

None yet

4 participants