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

WIP: Initial support for MDX #179

Closed
wants to merge 2 commits into from
Closed

WIP: Initial support for MDX #179

wants to merge 2 commits into from

Conversation

ibgreen
Copy link
Collaborator

@ibgreen ibgreen commented May 20, 2019

  • This integrates MDX page creation with our programmatic page creation system.

Remaining work:

  • The remaining work is in modules/gatsby/src/templates/doc-page-mdx.jsx, needs to use MDXRenderer per link below.
  • There may also be an issue with how to post-process links in MDX docs, as they seem to go through a different flow than pure markdown.

Links

options: {
extensions: ['.mdx']
}
},
Copy link
Contributor

Choose a reason for hiding this comment

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

just want to point out that this is precisely where ocular-gatsby is useful. existing sites just have to upgrade ocular-gatsby, not change their manual configurations or add new dependencies :)

).then(result => {
if (result.errors) {
/* eslint no-console: "off" */
console.log(result.errors);
Copy link
Contributor

Choose a reason for hiding this comment

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

no logger?


return queryMdxDocs(graphql)
.then(result => {
// const rootFolder = result.data.site.siteMetadata.config.ROOT_FOLDER;
Copy link
Contributor

Choose a reason for hiding this comment

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

why comment it out? is that temporary?

}
`;

// function replaceLinks(props) {
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI I'm considering extending this functionality to more elements for the "regular" doc file (ie replacing h1, h2, pre, table etc. DOM elements generated by markdown and whose styling depends on scss by styled components).

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Ib Green seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@ibgreen ibgreen deleted the ib/mdx branch March 15, 2021 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants