Improve runtime docs, closes #1176 (#1177)

mdx-js · Dec 17, 2020 · 84304b2 · 84304b2
1 parent 7398b98
commit 84304b2
Show file tree

Hide file tree

Showing 2 changed files with 200 additions and 711 deletions.
diff --git a/packages/runtime/readme.md b/packages/runtime/readme.md
@@ -31,6 +31,17 @@ yarn add @mdx-js/runtime
 
 Say we have the following scripts, `example.jsx`:
 
+### 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 {renderToString} from 'react-dom/server'
@@ -54,6 +65,8 @@ const children = `
 {1 + somethingInScope}
 
 <Demo />
+
+<div>Here is the scope variable: {some}</div>
 `
 
 const result = renderToString(