Skip to content
This repository has been archived by the owner on Feb 6, 2024. It is now read-only.

Update readme for gatsby-plugin-mdx #17

Closed
mpmccauley opened this issue Jul 16, 2020 · 2 comments · Fixed by #18
Closed

Update readme for gatsby-plugin-mdx #17

mpmccauley opened this issue Jul 16, 2020 · 2 comments · Fixed by #18
Labels
documentation Improvements or additions to documentation

Comments

@mpmccauley
Copy link
Contributor

Heyo! I really like the styling of these code blocks. Cool project!

For my website, I'm using gatsby-plugin-mdx instead of gatsby-transformer-remark.

I had no problem getting it to work, but it took me a few minutes to realize the gatsby-config.js needed to be tweaked slightly.

I would suggest adding a section to your readme for gatsby-plugin-mdx like this:

// In your gatsby-config.js
plugins: [
    {
      resolve: `gatsby-plugin-mdx`,
      options: {
        extensions: [".mdx", ".md"],
        gatsbyRemarkPlugins: [
          {
            resolve: `gatsby-remark-highlight-code`,
            options: {
              terminal: "ubuntu",
            },
          },
        ],
      },
    },
]

Cheers,
-Mike

@peterpeterparker
Copy link
Contributor

Oh I didn't know that, thx the issue Mike 👍

Sure sounds like a good idea to add something about it the README. Can you provide a PR?
I'll be happy to merge it :)

@mpmccauley
Copy link
Contributor Author

👍

@peterpeterparker peterpeterparker added the documentation Improvements or additions to documentation label Jul 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants