feat: 192 Expose RawDocumentData on vFile data field for Markdown/MDX Files
#195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implementation for the request in contentlayerdev#192 that also partially solves for contentlayerdev#11. In `@contentlayer/core` I added a new `data` field to the options argument of `markdownToHtml` and `bundleMDX` which can be used to pass arbitrary data to the resulting document's `vFile` `data` property. Not knowing how you want to structure utility functions for this library, in the initial implementation I've inlined the `addRawDocumentMeta` remark plugin used to append the vFile inside of both `markdownToHtml` and `bundleMDX`. Please advise me if you'd like this extracted out to somewhere else instead. In this PR I've only updated the `mapping.ts` file for the `source-files` package, as I'm unsure whether other sources like `source-contentful` expose the same `RawDocumentData` that the filesystem source does. Other sources can pass whatever document metadata is pertinent to them to the markdown processors using this addition to their APIs.
|
Saeris
changed the title
data field for Markdown/MDX Filesdata field for Markdown/MDX Files
|
Thanks a lot for this PR. I've addressed the underlying problem/usecase with the upcoming |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implementation for the request in #192 that also partially solves for #11.
In
@contentlayer/coreI added a newdatafield to the options argument ofmarkdownToHtmlandbundleMDXwhich can be used to pass arbitrary data to the resulting document'svFiledataproperty.Not knowing how you want to structure utility functions for this library, in the initial implementation I've inlined the
addRawDocumentMetaremark plugin used to append the vFile inside of bothmarkdownToHtmlandbundleMDX. Please advise me if you'd like this extracted out to somewhere else instead.In this PR I've only updated the
mapping.tsfile for thesource-filespackage, as I'm unsure whether other sources likesource-contentfulexpose the sameRawDocumentDatathat the filesystem source does. Other sources can pass whatever document metadata is pertinent to them to the markdown processors using this addition to their APIs.