Skip to content
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

Jump to bottom

Improve runtime docs, closes #1176 #1177

Merged
merged 1 commit into from
Jul 22, 2020
Merged

Improve runtime docs, closes #1176 #1177

Show file tree
Hide file tree
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
13 changes: 13 additions & 0 deletions packages/runtime/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ npm i -S @mdx-js/runtime

## Usage

### Props

The MDX Runtime component accepts two props:

| Name | Description |
| ------------ | ---------------------------------------------------------------- |
| `components` | Globally available components for the runtime |
| `scope` | Variables that are accessible in the JSX portion of the document |

### Example code

```jsx
import React from 'react'
import MDX from '@mdx-js/runtime'
Expand All @@ -40,6 +51,8 @@ const mdx = `
# Hello, world!

<Demo />

<div>Here is the scope variable: {some}</div>
`

export default () => (
Expand Down
Loading