Skip to content

Document the scope functionality of mdx-js/runtime #348

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Dec 8, 2018
Merged

Document the scope functionality of mdx-js/runtime #348

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions packages/runtime/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,25 @@ npm i -S @mdx-js/runtime
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} />
}

const mdx = '# Hello, world!'
// Provide custom components that will be referenced as JSX
// in the markdown string
const scope = {
Demo: props => <h1>This is a demo component</h1>
}

const mdx = '
# Hello, world!

<Demo />
'

export default () => (
<MDX components={components}>{mdx}</MDX>
<MDX components={components} scope={scope}>{mdx}</MDX>
)
```

Expand Down