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

source-files: Document markdown processing behaviour #20

Open
schickling opened this issue Feb 10, 2022 · 2 comments
Open

source-files: Document markdown processing behaviour #20

schickling opened this issue Feb 10, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@schickling
Copy link
Contributor

  • MDX: we're using mdx-bundler
  • Markdown: we're using unified with these plugins by default
@seancdavis seancdavis added the documentation Improvements or additions to documentation label May 11, 2022
@seancdavis
Copy link
Contributor

Noting that much has changed in this behavior in 0.2.5, and we should have a page for both Markdown and MDX that go into detail about the various options and patterns available.

We should also ensure we're linking to these pages from the technical reference.

This video has more context: https://cln.sh/I10Kzq

@seancdavis
Copy link
Contributor

seancdavis commented May 17, 2023

MDX page can be found here: https://www.contentlayer.dev/docs/sources/files/mdx

Markdown doc still needs to be written. And it'd be nice to have additional pages for JSON and YAML, just as a place to add syntax-specific notes.

Address these issues as part of this work:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants