question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[docs][workflows] Centralizing MDX docs on Gatsbyjs.org

See original GitHub issue

Part of the Top 25 Learning Workflows initiative. See #13708 for the meta issue that this issue falls under.

Description:

In an effort to centralize docs for MDX under the Gatsbyjs.org docs, all guides should be moved from the gatsby-mdx docs to .org. We should add createRedirects on the gatsby-mdx page as well to point users to Gatsby’s docs where documentation will continue for what is now gatsby-plugin-mdx.

~The name of the reference guides on MDX has been a question, should “Adding Components to Content with MDX” be changed to something that instead mentions adding JavaScript?~

  • add new page in Gatsby API section of the docs sidebar for MDX
  • move docs from gatsby-mdx.netlify.com to .org
  • create redirects from gatsby-mdx.netlify.com to corresponding pages on .org
  • update references to https://gatsby-mdx.netlify.com/ to new docs on .org
  • update references to gatsby-mdx to official plugin gatsby-plugin-mdx
  • clarify docs on using frontmatter and imports in the same file

Related:

#14258

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:9 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
gillkylecommented, Jun 24, 2019

Yeah that’s a good point @robinmetral, I know MDX uses rehype and remark internally (see here) so trying to push people towards MDX seems like a good idea there, though I think it’s great to have that documentation still the same.

0reactions
marcysuttoncommented, Sep 16, 2019

I checked in with Amberley and Kyle Gill, and it sounds like this one is indeed done now. Any remaining improvements can be handled in new issues and PRs. Thanks so much!

Read more comments on GitHub >

github_iconTop Results From Across the Web

[docs] [workflows] Embedding components in Markdown with MDX ...
As a new Gatsby user, I want to embed my React components into Markdown with MDX. Evaluation. [Change emoji below based on your...
Read more >
Adding MDX Pages | Gatsby
Importing JSX components into MDX documents. MDX allows you to use React components alongside Markdown. You can import components from third-party libraries ( ......
Read more >
gatsby-plugin-mdx
gatsby-plugin-mdx is the official integration for using MDX with Gatsby. MDX is markdown for the component era. It lets you write JSX…
Read more >
Part 5: Transform Data to Use MDX - Gatsby
In this part of the Tutorial, you'll learn about one particular transformer plugin, gatsby-plugin-mdx , which lets you use MDX, a file format...
Read more >
Markdown Syntax | Gatsby
MDX is a superset of Markdown. It allows you to write JSX inside markdown. This includes importing and rendering React components! Processing Markdown...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found