Need private packages and team management tools?Check out npm Teams »

@mdx-js/mdx

1.5.8 • Public • Published

@mdx-js/mdx

Build Status lerna Join the community on Spectrum

MDX implementation using remark.

Installation

npm:

npm i -S @mdx-js/mdx

Usage

const mdx = require('@mdx-js/mdx')
 
const result = await mdx(`
# Hello, MDX
 
I <3 Markdown and JSX
`)
 
console.log(result)

Yields:

export default ({components, ...props}) => (
  <MDXTag name="wrapper" components={components}>
    <MDXTag name="h1" components={components}>{`Hello, MDX`}</MDXTag>
    <MDXTag name="p" components={components}>{`I <3 Markdown and JSX`}</MDXTag>
  </MDXTag>
)

Contribute

See the Support and Contributing guidelines on the MDX website for ways to (get) help.

This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Compositor and ZEIT

Install

npm i @mdx-js/mdx

DownloadsWeekly Downloads

688,134

Version

1.5.8

License

MIT

Unpacked Size

17.9 kB

Total Files

8

Homepage

mdxjs.com

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar