A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
Add screenshot and clarify ipynb snapshotting docs (#7952)
Trevor Manzbbcb18cee406
diff --git a/docs/_static/docs-notebook-settings-snapshotting.jpg b/docs/_static/docs-notebook-settings-snapshotting.jpgnew file mode 100644index 0000000000..cf35a26c49Binary files /dev/null and b/docs/_static/docs-notebook-settings-snapshotting.jpg differdiff --git a/docs/_static/docs-notebook-settings-snapshotting.webp b/docs/_static/docs-notebook-settings-snapshotting.webpnew file mode 100644index 0000000000..87c67663adBinary files /dev/null and b/docs/_static/docs-notebook-settings-snapshotting.webp differdiff --git a/docs/guides/publishing/view_outputs_on_github.md b/docs/guides/publishing/view_outputs_on_github.mdindex 0939a351f1..161c6f9fe4 100644--- a/docs/guides/publishing/view_outputs_on_github.md+++ b/docs/guides/publishing/view_outputs_on_github.md@@ -1,15 +1,21 @@# View Outputs on GitHub-marimo notebooks are stored as pure Python files, in order to-work with Git versioning and the broader Python ecosystem. However, this means-that unlike Jupyter notebooks, by default you cannot see marimo notebook-outputs on GitHub.--If you would like to make outputs viewable on GitHub, you can configure-any given marimo notebook to automatically snapshot its outputs to an-`ipynb` file. The snapshot will be saved to a `__marimo__` directory-in the same folder where the notebook lives, which you can then-push to GitHub.--Enable snapshotting in the notebook settings menu, using the gear icon in the-top right of any notebook.+marimo notebooks are stored as pure Python files, which works well with Git+versioning and the broader Python ecosystem. However, this means you cannot+preview outputs directly on GitHub like you can with Jupyter notebooks.++To make outputs viewable on GitHub, you can configure marimo to automatically+snapshot outputs to an `ipynb` file. We treat the ipynb as an artifact that+combines your source code with rendered outputs. The snapshot is saved to a+`__marimo__` directory alongside your notebook, which you can commit and push+to GitHub.++Enable snapshotting in the notebook settings menu via the gear icon in the top+right corner:++<picture>+ <source srcset="/_static/docs-notebook-settings-snapshotting.webp" type="image/webp">+ <img src="/_static/docs-notebook-settings-snapshotting.jpg" alt="Notebook settings dialog showing the Exporting outputs section with HTML and ipynb checkboxes" style="max-width: 700px; width: 100%;" />+</picture>++This feature requires `nbformat`. marimo will prompt to install it if missing, or you can add it to your environment with `pip install nbformat`.