Skip to content

Commit b14098d

Browse files
authored
docs: add README to examples root (#4)
When linking to mdx examples via https://github.com/marimo-team/mdx-marimo/tree/main/examples we want visitors to be greeted with a README instead only the gh file tree.
1 parent dbe0e51 commit b14098d

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

examples/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Examples
2+
3+
These examples add reactive marimo cells to MDX pages in several hosts.
4+
Each folder contains a runnable integration.
5+
6+
| Host | Example |
7+
| -------------- | -------------------------------------- |
8+
| Astro | [`with-astro`](./with-astro) |
9+
| Docusaurus | [`with-docusaurus`](./with-docusaurus) |
10+
| Next.js | [`with-next`](./with-next) |
11+
| Nuxt | [`with-nuxt`](./with-nuxt) |
12+
| React and Vite | [`with-react`](./with-react) |
13+
| Vue and Vite | [`with-vue`](./with-vue) |
14+
15+
Use the same integration pattern with any host that supports
16+
[MDX](https://mdxjs.com/): add `remarkMarimo` to the host's MDX compiler, load
17+
the package stylesheet, and register the browser runtime. See
18+
[framework setup](../docs/api/frameworks.mdx) for the shared contract.

0 commit comments

Comments
 (0)