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

Correct descriptions/tags in Table of components #1331

Merged
merged 4 commits into from
Nov 30, 2020
Merged

Conversation

mrm007
Copy link
Contributor

@mrm007 mrm007 commented Nov 13, 2020

Fixed tags for mdast code, inlineCode and thematicBreak types.

Preview here: https://mdx-git-patch-1.mdx.vercel.app/table-of-components

@vercel
Copy link

vercel bot commented Nov 13, 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/m94vwpjp2
✅ Preview: https://mdx-git-patch-1.mdx.vercel.app

@vercel vercel bot temporarily deployed to Preview November 13, 2020 02:27 Inactive
@wooorm
Copy link
Member

wooorm commented Nov 13, 2020

Did you confirm that code is for inline code? I believe we have an inlineCode “element” for inline code:

tagName: 'inlineCode',
(also on next branch)

@vercel vercel bot temporarily deployed to Preview November 16, 2020 02:06 Inactive
@mrm007
Copy link
Contributor Author

mrm007 commented Nov 16, 2020

@wooorm you're right, of course. Fixed that row in the table.

@wooorm
Copy link
Member

wooorm commented Nov 16, 2020

thanks!

I’ve just been doing some work in this repo, which gave me some new insights on this table. Sure MDX supports markdown, but the components in MDXProvider can be anything. If you have an <Icon /> in MDX, you can have an Icon in components. Something like that might be good to mention here.
A different insight is that while the source is markdown-esque, and thus linking to mdast has some value, but it’s actually more HTML-like: <code> is also used because markdown code maps to pre and code.

So, for this PR: I think code has to be added back. And if you’d like to do more, although it could also be a new PR, a bigger refactor of this table, what it links to, and surrounding prose, might be helpful!

@vercel vercel bot temporarily deployed to Preview November 30, 2020 16:21 Inactive
@johno
Copy link
Member

johno commented Nov 30, 2020

Added back code, so going to go ahead and merge this. We should prolly create another issue to refactor this table in its entirety.

@johno johno merged commit 3925219 into mdx-js:master Nov 30, 2020
wooorm pushed a commit that referenced this pull request Dec 17, 2020
* Correct description for `hr`/`ThematicBreak`

* Correct description for code and inline code

* Fix tag for inlineCode

* Update docs/getting-started/-table-of-components.mdx

Co-authored-by: John Otander <[email protected]>
wooorm pushed a commit that referenced this pull request Dec 17, 2020
* Correct description for `hr`/`ThematicBreak`

* Correct description for code and inline code

* Fix tag for inlineCode

* Update docs/getting-started/-table-of-components.mdx

Co-authored-by: John Otander <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants