Skip to content

1.0.0
Compare
Choose a tag to compare
@jescalan jescalan released this 18 Aug 22:36
1.0.0
15d8a23
This commit was signed with the committer’s verified signature.
jescalan Jeff Escalante
GPG key ID: 32D23C61AB5450DB
Verified
Learn about vigilant mode.

⚠️ This is a BREAKING RELEASE and is guaranteed to require manual changes ⚠️

The big change is in the API. Previously, the two main functions were invoked as such:

renderToString(content, components, mdxOptions, scope)
hydrate(source, components)

Now, their signature has changed to move all arguments other than the first into an object, like this:

renderToString(content, { components, mdxOptions, scope })
hydrate(source, { components })

Additional small changes - react and react-dom were moved to peerDependencies where they belong - this shouldn't be an issue as they are also peer dependencies to nextjs, documentation was improved, and all dependencies in general were updated.

Commit Log

  • Fix error in readme example: 16f2d73
  • Add license file: c935c06
  • Improve function signatures: c9a6a55
  • Document scope param: 8484c73
  • Internal update source -> compiledSource: 32a1979
  • Move react and react-dom to peer deps: 5e37821
  • Update deps, add missing dep: 8ba807c
  • Add security note to readme: 00fdcd9
Assets 2
Loading