docs: marimo glance

[akshayka]

Document marimo glance for how to preview notebooks on GitHub. Also
touch up related files, including automatic snapshotting of ipynb and
configuration.

This PR also adds dead-link detection for anchor links, and fixes one dead link.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
marimo-docs	Ready	Preview, Comment	Jul 23, 2026 5:59pm

[Copilot]

Pull request overview

This PR expands the documentation around previewing marimo notebooks on GitHub (including the new “marimo glance” extension), clarifies related snapshotting/configuration guidance, and adds MkDocs anchor-link validation to help catch dead links during docs builds.

Changes:

• Enable MkDocs anchor link validation (warn on missing anchors).
• Document marimo glance GitHub/GitLab live previews and refine molab/GitHub publishing guidance.
• Update configuration docs terminology and fix/adjust internal links (including one dead link) plus add a GitHub preview FAQ entry.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
mkdocs.yml	Enable anchor-link validation warnings during docs builds.
docs/guides/working_with_data/dataframes.md	Fix formatting and update configuration anchor link.
docs/guides/publishing/github.md	Add marimo glance extension documentation and related preview notes.
docs/guides/molab.md	Clarify preview modes (static/WASM/server) and embedding guidance.
docs/guides/configuration/index.md	Rename/clarify “user settings” vs “notebook settings” and update guidance text.
docs/guides/coming_from/jupyter.md	Add GitHub preview guidance (ipynb + extension) and heading tweaks.
docs/faq.md	Add “preview notebooks on GitHub” FAQ entry.

Comments suppressed due to low confidence (2)

docs/guides/configuration/index.md:34

• Wording/grammar: "in the bottom" should be "at the bottom", and the sentence is missing an article before "configuration UI".

recommend using the marimo UI for a more user-friendly experience. Click the
"User settings" button in the bottom of the notebook settings menu to open
configuration UI, or hit `Cmd/Ctrl + k` to open the command palette and type
`"User settings"`.

docs/guides/coming_from/jupyter.md:153

• Spelling/capitalization: browser name should be "Firefox".

or [FireFox](https://addons.mozilla.org/en-US/firefox/addon/marimo-glance/)

[cubic-dev-ai]

All reported issues were addressed across 8 files

Architecture diagram

sequenceDiagram
    participant User as GitHub/GitLab User
    participant Browser as Browser (Extension/User)
    participant MGE as marimo glance Extension
    participant MServer as marimo Server (molab/editor)
    participant WASM as Pyodide WASM Runtime
    participant GH as GitHub/GitLab API

    Note over User,GH: NEW: marimo glance browser extension flow

    User->>Browser: Browse notebook source file on GitHub/GitLab
    Browser->>MGE: Detect marimo notebook (.py)
    MGE->>MGE: Look for ipynb session output in repo
    alt Session file exists
        GH->>WASM: Serve ipynb outputs (static preview)
    else No session file
        GH-->>WASM: No pre-rendered outputs
    end
    MGE->>Browser: Inject "Preview" button UI
    User->>MGE: Click preview button
    MGE->>GH: Fetch raw notebook source (.py)
    GH-->>MGE: Notebook source code
    MGE->>WASM: NEW: Pack source into URL fragment (hash)
    Note over MGE,WASM: Source never sent to external servers (private repos safe)
    WASM->>WASM: Execute notebook via Pyodide
    alt Notebook compatible
        WASM-->>Browser: Render interactive notebook UI
        User->>WASM: Interact with notebook
    else Incompatible notebook
        WASM-->>Browser: Display error/no render
        MGE->>MServer: alt: "Open in molab" click
        MServer->>GH: Fetch notebook source
        MServer-->>Browser: Server-hosted interactive notebook
    end

    Note over User,GH: CHANGED: GitHub static preview (ipynb commit)

    User->>GH: Commit ipynb session files to repo
    GH-->>User: ipynb visible in GitHub UI
    User->>GH: View notebook on GitHub
    GH->>Browser: Render ipynb (with cell outputs if committed)
    Browser-->>User: Static preview with outputs

    Note over User,MServer: CHANGED: molab preview options

    User->>MServer: Open notebook via molab
    alt Static preview
        MServer-->>Browser: Static preview (no runtime)
    else WebAssembly preview
        User->>MServer: Append /wasm or select Preview > WebAssembly
        MServer->>WASM: Load notebook for client-side execution
        WASM-->>Browser: Live, no-login, executable notebook
        User->>MServer: Copy embed iframe link
        MServer-->>User: iframe snippet for third-party embedding
    else Server-backed preview
        User->>MServer: Start ephemeral server
        MServer-->>Browser: Full server notebook runtime
    end

Loading

<sub>Reply with feedback, questions, or to request a fix.

Re-trigger cubic</sub>

[kirangadhave]

🚀

[github-actions]

🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.23.15-dev73