Skip to content

Commit 18a70bb

Browse files
authored
docs: overview page on sharing notebooks from github (marimo-team#3422)
1 parent 8afca24 commit 18a70bb

File tree

4 files changed

+15
-1
lines changed

4 files changed

+15
-1
lines changed

docs/guides/publishing/embedding.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ are two ways:
66

77
* Host on [GitHub Pages](github_pages.md) or [self-host WASM HTML](self_host_wasm.md),
88
and `<iframe>` the published notebook.
9-
* `<iframe>` a playground notebook, and [customize the embedding](playground.md#embedding-in-other-web-pages) with query params.
9+
* `<iframe>` a [playground](playground.md) notebook, and [customize the embedding](playground.md#embedding-in-other-web-pages) with query params.
1010
(This is what we do throughout docs.marimo.io.)
1111

1212
We plan to provide more turn-key solutions for static site generation with

docs/guides/publishing/from_github.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# From GitHub
2+
3+
marimo makes it very easy to share links to executable notebooks from notebooks
4+
hosted on GitHub. Unlike Google Colab, marimo also automatically synchronizes
5+
data stored in your GitHub repo to the notebook's filesystem, making it
6+
easy to bundle data with your notebooks.
7+
8+
9+
- Publish notebooks to [GitHub Pages](github_pages.md)
10+
- Edit notebooks on the [marimo playground](playground.md), with public link-based sharing
11+
(no login required!)
12+
- Synchronize to our [Community Cloud](community_cloud/index.md) for email-based sharing

docs/guides/publishing/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This guide provides an overview of the various ways to publish marimo notebooks.
1313
| Guide | Description |
1414
| ----------------------------------------------------- | ------------------------------------------------------------ |
1515
| [Embedding](embedding.md) | An overview of embedding notebooks in other sites |
16+
| [From GitHub](from_github.md) | How to share links to executable notebooks hosted on GitHUb |
1617
| [GitHub Pages](github_pages.md) | Publishing interactive notebooks on GitHub Pages |
1718
| [Online playground](playground.md) | Sharing notebook links using our online playground |
1819
| [Community Cloud](community_cloud/index.md) | Save notebooks to our free Community Cloud |

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ nav:
103103
- Publish to the web:
104104
- Publish to the web: guides/publishing/index.md
105105
- Embedding: guides/publishing/embedding.md
106+
- From GitHub: guides/publishing/from_github.md
106107
- GitHub Pages: guides/publishing/github_pages.md
107108
- Online playground: guides/publishing/playground.md
108109
- Community Cloud: guides/publishing/community_cloud/index.md

0 commit comments

Comments
 (0)