molab バッジの追加

"Open in molab" バッジを追加して marimo ノートブックにリンクします。バッジは GitHub README、ドキュメントサイト、ブログ記事、ウェブページ、その他の markdown/HTML ファイルなど、任意のターゲットに追加できます。

手順

0. molab のセッションエクスポート

molab プレビューは、GitHub リポジトリにセッション情報がある場合、より良いレンダリングが可能です。以下の方法で追加できます:

uvx marimo export session notebook.py
uvx marimo export session folder/

このコマンドはノートブックを実行し、セッションスナップショットをエクスポートします。molab はこれを使用して事前レンダリングされたノートブックを提供します。

主なフラグ:

• --sandbox — PEP 723 依存関係を使用した分離環境で各ノートブックを実行します
• --continue-on-error — 1 つのノートブックが失敗しても他の処理を続行します
• --force-overwrite — 最新版でも含め、既存のすべてのスナップショットを上書きします

1. ノートブックリンクを決定する

ユーザーはノートブックリンクを以下の 2 つの方法で提供できます:

• ユーザーが直接リンクを提供する場合。 ユーザーがノートブックへの URL を貼り付けます。これらはそのまま使用してください。検出は不要です。
• ノートブック検出 (README ターゲットのみ)。 ユーザーが README に対してバッジを追加するよう依頼し、どのノートブックかを指定していない場合は、検出してください:
  1. リポジトリ内のすべての marimo ノートブックファイル (.py ファイル) を検出します。**/*.py のようなパターンで Glob を使用し、marimo ヘッダー (import marimo または app = marimo.App) を確認して marimo ノートブックであることを確認してください。
  2. README が既にノートブックへのリンク (例: marimo.app リンクまたは既存のバッジ) を持っている場合は、それを置き換えてください。
  3. それ以外の場合は、ユーザーにどのノートブックをリンクするべきかを聞いてください。

2. molab URL を構築する

各ノートブックについて、以下の形式を使用して molab URL を構築します:

https://molab.marimo.io/github/{owner}/{repo}/blob/{branch}/{path_to_notebook}

• {owner}/{repo}: GitHub のオーナーとリポジトリ名。git リモート (git remote get-url origin)、ユーザーが提供した URL、またはユーザーへの問い合わせから決定してください。
• {branch}: 通常は main です。リポジトリのデフォルトブランチから確認してください。
• {path_to_notebook}: リポジトリのルートからの相対パスで、.py ノートブックファイルへのパス。

3. /wasm サフィックスルールを適用する

• 既存の marimo.app リンクを置き換える場合は、molab URL に /wasm を付加してください。これは marimo.app がノートブックをクライアント側 (WASM) で実行するためであり、molab は同等の動作を保持するために /wasm サフィックスが必要です。
• 新しいバッジを追加する場合 (marimo.app リンクを置き換えていない場合)、ユーザーが明示的にリクエストしない限り、/wasm を付加しないでください。

4. バッジをフォーマットする

以下の markdown バッジ形式を使用してください:

[![Open in molab](https://marimo.io/molab-shield.svg)](URL)

URL は構築された molab URL です (上記のルールに従って /wasm があるかないか)。

HTML ターゲットの場合は、以下を使用してください:

<a href="URL"><img src="https://marimo.io/molab-shield.svg" alt="Open in molab" /></a>

5. ターゲット内にバッジを挿入または置き換える

• 既存のバッジまたはリンクを置き換える場合:
  • marimo.app URL を同等の molab.marimo.io URL に置き換えてください。
  • 古いシールドイメージ URL (例: https://marimo.io/shield.svg または camo プロキシ版) を https://marimo.io/molab-shield.svg に置き換えてください。
  • alt テキストを Open in molab に設定してください。
  • 周囲のテキストと構造を保持してください。
• ターゲットファイルをインプレイスで編集してください。無関係なセクションを書き直さないでください。
• ユーザーがファイルを編集するのではなく、バッジ markdown/HTML だけが必要な場合は、直接出力してください。

例

README の marimo.app バッジを置き換える場合:

置き換え前:

[![](https://marimo.io/shield.svg)](https://marimo.app/github.com/owner/repo/blob/main/notebook.py)

置き換え後:

[![Open in molab](https://marimo.io/molab-shield.svg)](https://molab.marimo.io/github/owner/repo/blob/main/notebook.py/wasm)

注: このリンクが marimo.app を置き換えるため /wasm が付加されています。

ユーザーが提供したリンクから新しいバッジを追加する場合:

ユーザーが言った内容: "Add molab badges for these notebooks: https://github.com/owner/repo/blob/main/demo.py, https://github.com/owner/repo/blob/main/tutorial.py"

出力:

[![Open in molab](https://marimo.io/molab-shield.svg)](https://molab.marimo.io/github/owner/repo/blob/main/demo.py)
[![Open in molab](https://marimo.io/molab-shield.svg)](https://molab.marimo.io/github/owner/repo/blob/main/tutorial.py)

注: 新しいバッジではデフォルトで /wasm サフィックスはありません。