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

Updates MDX docs #56378

Merged
merged 6 commits into from Oct 3, 2023
Merged

Updates MDX docs #56378

merged 6 commits into from Oct 3, 2023

Conversation

manovotny
Copy link
Contributor

@manovotny manovotny commented Oct 3, 2023

When trying to update my own website to use App Router, I found the current Next.js Docs were missing specifics to get it working (most notably, no mention of pageExtensions). Coupled with community feedback, we decided to revisit and rework the entire page.

The page has been walked through and tested on brand new create-next-app projects for both App and Pages Routers to ensure completeness.

Closes DX-2095

Rendered pages while running locally, in case they are more helpful in seeings the changes and different between routers.

App Router

localhost_3332_docs_pages_building-your-application_configuring_mdx (1)

Pages Router

localhost_3332_docs_pages_building-your-application_configuring_mdx

@manovotny manovotny marked this pull request as ready for review October 3, 2023 19:10
@manovotny manovotny requested review from a team as code owners October 3, 2023 19:10
@manovotny manovotny requested review from timeyoutakeit and steven-tey and removed request for a team October 3, 2023 19:10
@manovotny manovotny changed the title Mdx docs Updates MDX docs Oct 3, 2023
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.

Love it!

@kodiakhq kodiakhq bot merged commit f77f222 into canary Oct 3, 2023
54 of 56 checks passed
@kodiakhq kodiakhq bot deleted the mdx-docs branch October 3, 2023 19:32
@dominik-sfl
Copy link

dominik-sfl commented Oct 7, 2023

This is great. One thing I haven't been able to figure out is how to get access to the meta object that is exported from the mdx files? And how would I then get access to all of my mdx files' metadata (if I wanted to loop over them, for, e.g. a blog index).

Would it be possible to add more examples or explanations of those issues, relating to metadata & creating a blog index page? Or maybe see a little example project that uses @next/mdx to create a basic blog? There does not seem to be much online, most of the tutorial are using next-mdx-remote.

@github-actions github-actions bot added the locked label Nov 2, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants