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.

Sign up for GitHub

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

Jump to bottom

Mention remark-mdx-frontmatter in frontmatter docs #59238

Merged
merged 2 commits into from
Dec 22, 2023
Merged

Mention remark-mdx-frontmatter in frontmatter docs #59238

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
344bdea
Mention remark-mdx-frontmatter in frontmatter docs
remcohaszing Dec 4, 2023
1899d03
Revert unwanted documentation changes
remcohaszing Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/02-app/01-building-your-application/07-configuring/05-mdx.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,7 @@ export default withMDX(nextConfig)
Frontmatter is a YAML like key/value pairing that can be used to store data about a page. `@next/mdx` does **not** support frontmatter by default, though there are many solutions for adding frontmatter to your MDX content, such as:

- [remark-frontmatter](https://github.com/remarkjs/remark-frontmatter)
- [remark-mdx-frontmatter](https://github.com/remcohaszing/remark-mdx-frontmatter)
remcohaszing marked this conversation as resolved.
Show resolved Hide resolved
- [gray-matter](https://github.com/jonschlinkert/gray-matter).

To access page metadata with `@next/mdx`, you can export a metadata object from within the `.mdx` file:
Expand Down
Loading