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

docs(workflows): new guide about importing and using components in MDX #21285

Merged
merged 8 commits into from
Feb 18, 2020

Conversation

gillkyle
Copy link
Contributor

@gillkyle gillkyle commented Feb 7, 2020

Description

To go along with the workflow for using style libraries and components from other sources: #21278, these changes add a new guide for using third-party components.

Because this content isn't exactly new, I updated content and combined some things with some more nuance on this new page, linking everything together.

Screenshots

Importing and Using Components

localhost_8000_docs_mdx_importing-and-using-components_

Related Issues

Related to #21278

@gillkyle gillkyle marked this pull request as ready for review February 7, 2020 23:47
@gillkyle gillkyle requested review from a team as code owners February 7, 2020 23:47
@gillkyle gillkyle added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Feb 7, 2020
Copy link
Contributor

@laurieontech laurieontech left a comment

Choose a reason for hiding this comment

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

This is awesome. I finally understand what in the world short codes are! Made a couple suggestions. Also wondering if it's worth showing an example of how the MdxProvider is used in the layout? It may not be, but figured it was worth considering.

docs/docs/mdx/importing-and-using-components.md Outdated Show resolved Hide resolved
docs/docs/mdx/importing-and-using-components.md Outdated Show resolved Hide resolved
docs/docs/mdx/importing-and-using-components.md Outdated Show resolved Hide resolved
docs/docs/mdx/importing-and-using-components.md Outdated Show resolved Hide resolved
docs/docs/mdx/importing-and-using-components.md Outdated Show resolved Hide resolved
docs/docs/mdx/importing-and-using-components.md Outdated Show resolved Hide resolved
@ehowey
Copy link
Contributor

ehowey commented Feb 11, 2020

cc @tomhermans - As per our discussion take a look at this PR, I think this is giving you more of the details and answers you were looking for with short codes and components in MDX.

Co-Authored-By: LB <barth.laurie@gmail.com>
@laurieontech laurieontech added the status: awaiting author response Additional information has been requested from the author label Feb 12, 2020
Co-Authored-By: LB <barth.laurie@gmail.com>
@laurieontech
Copy link
Contributor

LGTM!

@laurieontech laurieontech merged commit 9884cd8 into master Feb 18, 2020
@delete-merged-branch delete-merged-branch bot deleted the docs/workflows/using-components-in-mdx branch February 18, 2020 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: awaiting author response Additional information has been requested from the author type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants