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

chore(docs): add mdx-embed guide #1400

Merged
merged 2 commits into from
Dec 21, 2020
Merged

Conversation

PaulieScanlon
Copy link
Contributor

Add MDX Embed installation and links to readme

@vercel
Copy link

vercel bot commented Dec 20, 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/in2sk7jvw
✅ Preview: Failed

[Deployment for e9a01a2 failed]

@vercel vercel bot temporarily deployed to Preview December 20, 2020 17:31 Inactive
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 @PaulieScanlon!
Could we move this to https://github.com/mdx-js/awesome? Or maybe to a guide (https://github.com/mdx-js/mdx/tree/main/docs/guides)? Maybe both?

the main readme points folks towards where to learn basics, intentionally concise, linking out to guides, rather than being comprehensive.

mdx-embed does meet the 30+ day and 50+ star requirements for https://github.com/mdx-js/awesome and would I be happy to see it as an awesome community project ✨

@johno
Copy link
Member

johno commented Dec 21, 2020

Following along with @ChristianMurphy, I'd love to see this in docs/guides/mdx-embed as its own file (Which we will add nav to before v2 goes live), aside from that it looks great!

@vercel vercel bot temporarily deployed to Preview December 21, 2020 14:56 Inactive
@PaulieScanlon
Copy link
Contributor Author

Hi @johno and @ChristianMurphy I've moved this to docs/guides/mdx-embed and added a link to the new page in docs/guides/index

Happy to make further changes if you like.

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.

Thank you @PaulieScanlon!

@johno johno merged commit e905f9c into mdx-js:main Dec 21, 2020

### Usage

```javascript
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```javascript
```mdx

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.

None yet

3 participants