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

Added guide for setting up Next.js with MDX #30869

Merged
merged 16 commits into from
Nov 22, 2021
Merged

Conversation

molebox
Copy link
Collaborator

@molebox molebox commented Nov 3, 2021

This PR adds a new section on using MDX. It includes a guide for setting up Next.js with @next/mdx

Bug

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using Fixes: https://github.com/vercel/product/issues/35
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes by running yarn lint

@molebox molebox requested a review from leerob November 3, 2021 09:21
@molebox molebox changed the title Added guides for setting up Next.js with MDX Added guides for setting up Next.js with MDX - WIP Nov 3, 2021
@molebox molebox changed the title Added guides for setting up Next.js with MDX - WIP Added guide for setting up Next.js with MDX Nov 3, 2021
@styfle
Copy link
Member

styfle commented Nov 11, 2021

Lint is failing because manifest file needs to be updated

No missing paths in errors/manifest.json
Missing paths in docs/manifest.json:
docs/advanced-features/using-mdx.md
Error: missing/incorrect manifest items detected see above
    at main (/home/runner/work/next.js/next.js/scripts/check-manifests.js:61:11)

@molebox
Copy link
Collaborator Author

molebox commented Nov 12, 2021

Lint is failing because manifest file needs to be updated

No missing paths in errors/manifest.json
Missing paths in docs/manifest.json:
docs/advanced-features/using-mdx.md
Error: missing/incorrect manifest items detected see above
    at main (/home/runner/work/next.js/next.js/scripts/check-manifests.js:61:11)

Ah, thanks @styfle! Just added it

docs/advanced-features/using-mdx.md Show resolved Hide resolved
docs/advanced-features/using-mdx.md Outdated Show resolved Hide resolved
docs/advanced-features/using-mdx.md Outdated Show resolved Hide resolved
docs/advanced-features/using-mdx.md Show resolved Hide resolved
docs/advanced-features/using-mdx.md Outdated Show resolved Hide resolved
docs/advanced-features/using-mdx.md Outdated Show resolved Hide resolved
docs/advanced-features/using-mdx.md Outdated Show resolved Hide resolved
docs/advanced-features/using-mdx.md Outdated Show resolved Hide resolved
docs/advanced-features/using-mdx.md Show resolved Hide resolved
@molebox molebox requested a review from leerob November 17, 2021 10:52
@molebox
Copy link
Collaborator Author

molebox commented Nov 18, 2021

What say thee @styfle @leerob can we land this?

Copy link
Member

@leerob leerob left a comment

Choose a reason for hiding this comment

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

LGTM after last comment

Co-authored-by: Steven <steven@ceriously.com>

```md
export const meta = {
author: 'Rich Haines'
Copy link
Member

Choose a reason for hiding this comment

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

It looks like we didn't get this spacing adjusted - maybe it needs to be js instead of md?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hmm, that could be it! Rather odd. We should adjust the config for that, as I pulled this out so js makes sense, but it was in the context of an md file, so should format.

@kodiakhq kodiakhq bot merged commit 91e8620 into vercel:canary Nov 22, 2021
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants