Documentation for usage of custom components is sparse

[alexerhardt]

Loving the library thus far, fantastic work.

I am a newcomer to the world of MDX and I've been trying to figure out a fairly simple task: how to map markdown to the custom components in my website (which uses a heavily themed MUI).

The Contentlayer official doc for this is here:
https://www.contentlayer.dev/docs/sources/files/mdx

However, the doc is very sparse, and delegates on mdx-bundler, which does not have very extensive documentation either.

Not even reading the MDX docs did I could find how to do this...

Finally I found an example in a GitHub repo of exactly what I wanted to do:
https://github.com/VdustR/example-material-ui-mdx/blob/master/src/components.js

I think this is going to be a common problem for a lot of newcomers - the markdown mappings will not map well to their site's design systems and it's something they will need to customize.

Contentlayer is a great framework for adopting MDX, maybe it should point to those resources more clearly?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.