[go: up one dir, main page]

Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thecuvii committed Oct 17, 2022
1 parent 729fdd3 commit c6a05b9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Maybe different for each MDX plugin you use, check out [examples](#Compatible) b

### 3. Write your code

````mdx
````md

import { Sandpack } from '@codesandbox/sandpack-react';

Expand Down Expand Up @@ -51,7 +51,7 @@ h1{

All props will pass to `Sandpack` directly, except `files`.

````mdx
````md

<Sandpack
theme={theme}
Expand All @@ -75,7 +75,7 @@ All code blocks inside `<Sandpack></Sandpack>` will be parsed, then be passed as

That means you can define [file property](https://sandpack.codesandbox.io/docs/getting-started/custom-content#advanced-usage) in code block meta.

````
````md

<Sandpack>
```js src/index.js active readOnly
Expand All @@ -91,7 +91,7 @@ console.log('I'm hidden')

Code above will transform into:

```
```tsx
<Sandpack
files={{
"src/index.js": {
Expand All @@ -115,8 +115,8 @@ TODO

## Compatible

- βœ… next.js with @next/mdx. πŸ‘‰πŸ»[example](examples/next-mdx/pages/index.mdx)
- βœ… next.js with next-remote-mdx. πŸ‘‰πŸ»[example](examples/next-mdx-remote/pages/index.tsx)
- βœ… next.js with @next/mdx. πŸ‘‰πŸ»[example](examples/next-mdx)
- βœ… next.js with next-remote-mdx. πŸ‘‰πŸ»[example](examples/next-mdx-remote)
- ❎ docusaurus


Expand Down

0 comments on commit c6a05b9

Please sign in to comment.