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

@mdx-js/runtime

1.5.7 • Public • Published

@mdx-js/runtime

Build Status lerna Join the community on Spectrum

Parse and render MDX in a runtime environment.

⚠️ warning: this is not the preferred way to use MDX since it introduces a substantial amount of overhead and dramatically increases bundle sizes. It should also not be used with user input that isn’t sandboxed.

Installation

npm:

npm i -S @mdx-js/runtime

Usage

import React from 'react'
import MDX from '@mdx-js/runtime'
 
// Provide custom components for markdown elements
const components = {
  h1: props => <h1 style={{color: 'tomato'}} {...props} />,
  Demo: props => <h1>This is a demo component</h1>
}
 
// Provide variables that might be referenced by JSX
const scope = {
  some: 'value'
}
 
const mdx = `
# Hello, world!
 
<Demo />
`
 
export default () => (
  <MDX components={components} scope={scope}>
    {mdx}
  </MDX>
)

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/runtime

DownloadsWeekly Downloads

1,239

Version

1.5.7

License

MIT

Unpacked Size

17.2 kB

Total Files

7

Homepage

mdxjs.com

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar