`@mdx-js/runtime`

Parse and render MDX in a runtime environment.

:warning: 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 contributing.md in mdx-js/mdx for ways to get started.

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

License

Current Tags

2.0.0-ci.53 ... ci (3 years ago)
1.6.22 ... latest (4 years ago)
2.0.0-next.9 ... next (4 years ago)

177 Versions

2.0.0-ci.53 ... 3 years ago
2.0.0-ci.50 ... 3 years ago
2.0.0-ci.43 ... 3 years ago
2.0.0-ci.42 ... 3 years ago
2.0.0-ci.40 ... 3 years ago
2.0.0-ci.39 ... 3 years ago
2.0.0-ci.35 ... 3 years ago
2.0.0-ci.18 ... 3 years ago
2.0.0-ci.15 ... 3 years ago
2.0.0-ci.4 ... 4 years ago
2.0.0-ci.3 ... 4 years ago
2.0.0-next.9 ... 4 years ago
1.6.22 ... 4 years ago
1.6.21 ... 4 years ago
1.6.20 ... 4 years ago
1.6.19 ... 4 years ago
2.0.0-next.8 ... 4 years ago
1.6.18 ... 4 years ago
1.6.17 ... 4 years ago
2.0.0-next.7 ... 4 years ago
1.6.16-ci.0 ... 4 years ago
1.6.16 ... 4 years ago
1.6.15 ... 4 years ago
2.0.0-next.6 ... 4 years ago
1.6.14 ... 4 years ago
2.0.0-next.4 ... 4 years ago
1.6.13-ci.1 ... 4 years ago
1.6.13 ... 4 years ago
1.6.12-ci.2 ... 4 years ago
1.6.12 ... 4 years ago
2.0.0-next.3 ... 4 years ago
1.6.11 ... 4 years ago
1.6.11-ci.0 ... 4 years ago
1.6.10-ci.0 ... 4 years ago
1.6.10 ... 4 years ago
1.6.9-ci.0 ... 4 years ago
1.6.9 ... 4 years ago
1.6.8 ... 4 years ago
1.6.8-ci.4 ... 4 years ago
1.6.7 ... 4 years ago
1.6.7-ci.4 ... 4 years ago
1.6.6 ... 4 years ago
1.6.5 ... 4 years ago
2.0.0-next.1 ... 4 years ago
1.6.4 ... 4 years ago
2.0.0-next.0 ... 4 years ago
1.6.3 ... 4 years ago
1.6.2 ... 4 years ago
1.6.2-ci.1 ... 5 years ago
1.6.1 ... 5 years ago
1.6.0 ... 5 years ago
1.5.9 ... 5 years ago
1.5.9-ci.5 ... 5 years ago
1.5.8 ... 5 years ago
1.5.8-ci.13 ... 5 years ago
1.5.8-alpha.0 ... 5 years ago
1.5.7 ... 5 years ago
1.5.7-alpha.0 ... 5 years ago
1.5.6 ... 5 years ago
1.5.6-alpha.0 ... 5 years ago
1.5.6-ci.0 ... 5 years ago
1.5.5 ... 5 years ago
1.5.4 ... 5 years ago
1.5.3 ... 5 years ago
1.5.2 ... 5 years ago
1.5.1 ... 5 years ago
1.5.0 ... 5 years ago
1.4.5 ... 5 years ago
1.4.4 ... 5 years ago
1.4.3 ... 5 years ago
1.4.2 ... 5 years ago
1.4.1 ... 5 years ago
1.4.0 ... 5 years ago
1.3.2 ... 5 years ago
1.3.1 ... 5 years ago
1.3.0 ... 5 years ago
1.2.2 ... 5 years ago
1.2.1 ... 5 years ago
1.1.6 ... 5 years ago
1.1.5 ... 5 years ago
1.1.4 ... 5 years ago
1.1.2 ... 5 years ago
1.1.2-ci.2 ... 5 years ago
1.1.1-ci.44 ... 5 years ago
1.1.1 ... 5 years ago
1.1.0 ... 5 years ago
1.0.27-ci.0 ... 5 years ago
1.0.27 ... 5 years ago
1.0.26 ... 5 years ago
1.0.25 ... 5 years ago
1.0.24 ... 5 years ago
1.0.24-ci.5 ... 5 years ago
1.0.24-ci.3 ... 5 years ago
1.0.23 ... 5 years ago
1.0.22 ... 5 years ago
1.0.21 ... 5 years ago
1.0.20 ... 5 years ago
1.0.20-ci.2 ... 6 years ago
1.0.19-ci.5 ... 6 years ago
1.0.19 ... 6 years ago
1.0.18 ... 6 years ago
1.0.16 ... 6 years ago
1.0.16-ci.0 ... 6 years ago
1.0.15 ... 6 years ago
1.0.14 ... 6 years ago
1.0.10 ... 6 years ago
1.0.9 ... 6 years ago
1.0.8 ... 6 years ago
1.0.7 ... 6 years ago
1.0.6 ... 6 years ago
1.0.5-ci.0 ... 6 years ago
1.0.5 ... 6 years ago
1.0.4 ... 6 years ago
1.0.4-ci.0 ... 6 years ago
1.0.3-ci.2 ... 6 years ago
1.0.3 ... 6 years ago
1.0.2 ... 6 years ago
1.0.1 ... 6 years ago
1.0.0-ci.0 ... 6 years ago
1.0.0-rc.4 ... 6 years ago
1.0.0-rc.3 ... 6 years ago
1.0.0-rc.2 ... 6 years ago
1.0.0-rc.0 ... 6 years ago
1.0.0-alpha.17 ... 6 years ago
1.0.0-alpha.16 ... 6 years ago
1.0.0-alpha.13 ... 6 years ago
1.0.0-alpha.11 ... 6 years ago
1.0.0-alpha.10 ... 6 years ago
1.0.0-alpha.9 ... 6 years ago
1.0.0-alpha.8 ... 6 years ago
1.0.0-alpha.7 ... 6 years ago
1.0.0-alpha.6 ... 6 years ago
1.0.0-alpha.5 ... 6 years ago
1.0.0-alpha.1 ... 6 years ago
0.20.3 ... 6 years ago
1.0.0-alpha.0 ... 6 years ago
0.20.2 ... 6 years ago
0.20.1 ... 6 years ago
0.20.0 ... 6 years ago
0.20.0-alpha.0 ... 6 years ago
0.19.0 ... 6 years ago
0.19.0-alpha.0 ... 6 years ago
0.18.2 ... 6 years ago
0.18.1 ... 6 years ago
0.18.0 ... 6 years ago
0.17.5 ... 6 years ago
0.17.4 ... 6 years ago
0.17.3 ... 6 years ago
0.17.0 ... 6 years ago
0.16.9 ... 6 years ago
0.16.8 ... 6 years ago
0.16.6 ... 6 years ago
0.16.5 ... 6 years ago
0.16.4 ... 6 years ago
0.16.3 ... 6 years ago
0.16.2 ... 6 years ago
0.16.1 ... 6 years ago
0.16.0 ... 6 years ago
0.15.7 ... 6 years ago
0.15.6 ... 6 years ago
0.15.5 ... 6 years ago
0.15.4 ... 6 years ago
0.15.3 ... 6 years ago
0.15.3-0 ... 6 years ago
0.15.2 ... 6 years ago
0.15.1 ... 6 years ago
0.15.0 ... 6 years ago
0.15.0-4 ... 6 years ago
0.15.0-3 ... 6 years ago
0.15.0-2 ... 6 years ago
0.15.0-1 ... 6 years ago
0.15.0-0 ... 6 years ago
0.14.1 ... 6 years ago
0.14.0 ... 6 years ago
0.13.1-1 ... 6 years ago
0.13.1-0 ... 6 years ago
0.13.0-0 ... 6 years ago