Improve runtime docs, closes #1176 (#1177)

mdx-js · Jul 22, 2020 · f12b1ee · f12b1ee · vercel · Jul 22, 2020
1 parent 033d7bc
commit f12b1ee
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 460 deletions.
diff --git a/packages/runtime/readme.md b/packages/runtime/readme.md
@@ -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'
@@ -40,6 +51,8 @@ const mdx = `
 # Hello, world!
 
 <Demo />
+
+<div>Here is the scope variable: {some}</div>
 `
 
 export default () => (