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

feat(www): Convert API pages to MDX #20763

Merged
merged 24 commits into from
Feb 10, 2020
Merged

feat(www): Convert API pages to MDX #20763

merged 24 commits into from
Feb 10, 2020

Conversation

tesseralis
Copy link
Contributor

@tesseralis tesseralis commented Jan 21, 2020

Update of @Sever1an's PR here to bring it up to date with master.

Make all the API pages markdown pages with their own custom template template-api-markdown. Frontmatter can be used to determine what JSDoc to query, API calls to use, etc.

Related Issues

Fixes: #19035

Bailey Swartz and others added 10 commits November 6, 2019 05:14

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
…rted some api docs to MDX, but they still need to be verified. More testing is needed.
…cts data directly to be used within components of hte page, all MDX files have been adjusted. This exposes the headings for translation.
…nted in the root of the file, which is consistent with the other doc files.
…files, not a regexp. Updated mdx to new convention.
…s. Perhaps someday they can be added with the suggested names. Fixed issue where types were not shown on top level items in `node-api-helpers.mdx`. They were a side-effect of how the api jsdoc was written/queried, should they not exist?
@tesseralis tesseralis requested a review from pieh January 21, 2020 23:29
@tesseralis tesseralis requested review from a team as code owners January 21, 2020 23:29
docs/docs/actions.mdx Outdated Show resolved Hide resolved
www/src/templates/template-api-markdown.js Outdated Show resolved Hide resolved
www/gatsby-node.js Outdated Show resolved Hide resolved
@tesseralis tesseralis requested review from freiksenet and removed request for freiksenet January 22, 2020 21:23
@pieh pieh self-assigned this Jan 27, 2020
@AishaBlake
Copy link

Will have to deal with the merge conflicts but this makes sense to me. I'd definitely like some input from someone on Core when they're able.

@tesseralis tesseralis changed the title Convert API pages to MDX (repost) Convert API pages to MDX Feb 9, 2020
docs/docs/node-api-helpers.md Outdated Show resolved Hide resolved
docs/docs/actions.md Outdated Show resolved Hide resolved
docs/docs/node-model.md Outdated Show resolved Hide resolved
pieh
pieh previously requested changes Feb 10, 2020
Copy link
Contributor

@pieh pieh 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 great! Just couple of changes and we can get this in!

tesseralis and others added 7 commits February 10, 2020 10:33
Co-Authored-By: Michal Piechowiak <misiek.piechowiak@gmail.com>
Co-Authored-By: Michal Piechowiak <misiek.piechowiak@gmail.com>
Co-Authored-By: Michal Piechowiak <misiek.piechowiak@gmail.com>
@tesseralis
Copy link
Contributor Author

@pieh merged in all the changes! Should be straightforward but I'm waiting for my local build to finish to test that everything works out well.

@pieh pieh dismissed their stale review February 10, 2020 20:44

Changes were made

@pieh pieh changed the title Convert API pages to MDX feat(www): Convert API pages to MDX Feb 10, 2020
Copy link
Contributor

@pieh pieh left a comment

Choose a reason for hiding this comment

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

Awesome!

Thanks @Sever1an for initial work and @tesseralis for finishing it up!

@pieh pieh merged commit c905014 into gatsbyjs:master Feb 10, 2020
@pieh pieh mentioned this pull request Feb 10, 2020
2 tasks
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.

Convert API pages to MDX.
4 participants