Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: overview page on sharing notebooks from github #3422

Merged
merged 2 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/publishing/embedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ are two ways:

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

We plan to provide more turn-key solutions for static site generation with
Expand Down
12 changes: 12 additions & 0 deletions docs/guides/publishing/from_github.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# From GitHub

marimo makes it very easy to share links to executable notebooks from notebooks
hosted on GitHub. Unlike Google Colab, marimo also automatically synchronizes
data stored in your GitHub repo to the notebook's filesystem, making it
easy to bundle data with your notebooks.


- Publish notebooks to [GitHub Pages](github_pages.md)
- Edit notebooks on the [marimo playground](playground.md), with public link-based sharing
(no login required!)
- Synchronize to our [Community Cloud](community_cloud/index.md) for email-based sharing
1 change: 1 addition & 0 deletions docs/guides/publishing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This guide provides an overview of the various ways to publish marimo notebooks.
| Guide | Description |
| ----------------------------------------------------- | ------------------------------------------------------------ |
| [Embedding](embedding.md) | An overview of embedding notebooks in other sites |
| [From GitHub](from_github.md) | How to share links to executable notebooks hosted on GitHUb |
| [GitHub Pages](github_pages.md) | Publishing interactive notebooks on GitHub Pages |
| [Online playground](playground.md) | Sharing notebook links using our online playground |
| [Community Cloud](community_cloud/index.md) | Save notebooks to our free Community Cloud |
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ nav:
- Publish to the web:
- Publish to the web: guides/publishing/index.md
- Embedding: guides/publishing/embedding.md
- From GitHub: guides/publishing/from_github.md
- GitHub Pages: guides/publishing/github_pages.md
- Online playground: guides/publishing/playground.md
- Community Cloud: guides/publishing/community_cloud/index.md
Expand Down
Loading