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.

Sign up for GitHub

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

Jump to bottom

chore(gatsby-plugin-mdx): Use MDX v1 for install instructions (#34774) #34817

Merged
merged 1 commit into from
Feb 15, 2022
Merged

chore(gatsby-plugin-mdx): Use MDX v1 for install instructions (#34774) #34817

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 4 additions & 10 deletions packages/gatsby-plugin-mdx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![Logo](./img/gatsby-mdx.png)

> `gatsby-plugin-mdx` is the official integration for using [MDX](https://mdxjs.com)
> with [Gatsby](https://www.gatsbyjs.org/).
> with [Gatsby](https://www.gatsbyjs.com).

# What’s MDX?

Expand All @@ -18,7 +18,7 @@ MDX seeks to make writing with Markdown and JSX simpler while being more express

### Read more about MDX

- [📚 Gatsby guide](https://www.gatsbyjs.org/docs/mdx/)
- [📚 Gatsby guide](https://www.gatsbyjs.com/docs/mdx/)
- [📣 Language](https://mdxjs.com)
- [👩‍🔬 Specification](https://github.com/mdx-js/specification)

Expand Down Expand Up @@ -49,16 +49,10 @@ MDX seeks to make writing with Markdown and JSX simpler while being more express

## Installation

Install with npm:
Install:

```shell
npm install gatsby-plugin-mdx @mdx-js/mdx @mdx-js/react
```

Install with yarn:

```shell
yarn add gatsby-plugin-mdx @mdx-js/mdx @mdx-js/react
npm install gatsby-plugin-mdx @mdx-js/mdx@v1 @mdx-js/react@v1
```

## Usage
Expand Down