# jupyter-notebook-writing

jupyter-notebook-writing — a skill for editing Jupyter notebooks in Markdown instead of JSON. Runs on Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, and OpenCode; edit .md files first, then convert to .ipynb using jupyter-switch.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 3900 installs
- Author: zc277584121
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/zc277584121/marketing-skills/tree/HEAD/skills/jupyter-notebook-writing/SKILL.md
- Updated: 2026-08-28
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/jupyter-notebook-writing

## What it does

Jupyter notebooks stored as `.ipynb` are JSON with metadata, execution counts, and cell outputs — difficult for AI to edit directly. This skill flips the workflow: write examples in clean Markdown where Python code blocks become code cells and everything else becomes Markdown cells. After editing the `.md` file, run `uvx jupyter-switch example.md` to generate the notebook; Markdown stays as the source of truth for future edits.

The skill walks through running notebooks: detect available Python environments (conda, mamba, venv, registered Jupyter kernels), present them to the user, register a new kernel if needed, then run `jupyter execute` with the right kernel name. Before execution, comment out cells with `pip install` and API key placeholders — these must be installed and set outside the notebook to avoid test failures.

The structure template covers Prerequisites, Setup, data preparation, collection creation, queries, and cleanup. Focused on Milvus application examples: RAG, semantic search, hybrid search.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add zc277584121/marketing-skills --skill jupyter-notebook-writing -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/jupyter-notebook-writing/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/jupyter-notebook-writing/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add zc277584121/marketing-skills --skill jupyter-notebook-writing -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/jupyter-notebook-writing/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add zc277584121/marketing-skills --skill jupyter-notebook-writing -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/jupyter-notebook-writing/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install zc277584121/marketing-skills skills/jupyter-notebook-writing
```

2. **Manually: put the files in place**
- File: `.github/skills/jupyter-notebook-writing/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add zc277584121/marketing-skills --skill jupyter-notebook-writing -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/zc277584121/marketing-skills --path skills/jupyter-notebook-writing
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/jupyter-notebook-writing/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add zc277584121/marketing-skills --skill jupyter-notebook-writing -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/zc277584121/marketing-skills/tree/HEAD/skills/jupyter-notebook-writing/SKILL.md

## When to use it
- edit notebooks without managing JSON and metadata
- keep Markdown documentation and `.ipynb` in sync
- pick the correct Python environment to run a notebook
- run a notebook in CI without conflicts from setup cells
- quickly create a Milvus application example

## Example prompts
- Create a Markdown file with a Milvus RAG example and convert it to a notebook
- Edit an existing `.ipynb`, convert to Markdown, revise the text, convert back
- Run a notebook in the right environment by selecting a Jupyter kernel from a list

## Similar
- [jupyter-notebook](https://affpapa.org/en/nevibecode/skills/jupyter-notebook.md) — skill · 6100 installs
- [openai-jupyter-notebook](https://affpapa.org/en/nevibecode/plugins/openai-jupyter-notebook.md) — plugin · ★ 540 repo stars
- [Jupyter Notebook taste](https://affpapa.org/en/nevibecode/prompts/jupyter-notebook-taste.md) — prompt · ★ 178201 repo stars
- [marimo-notebook](https://affpapa.org/en/nevibecode/skills/marimo-notebook.md) — skill · 6200 installs
- [jupyter-to-marimo](https://affpapa.org/en/nevibecode/skills/jupyter-to-marimo.md) — skill · 3600 installs
- [data-jupyter-python](https://affpapa.org/en/nevibecode/skills/data-jupyter-python.md) — skill · 913 installs

From the same set: [zc277584121/marketing-skills](https://affpapa.org/en/nevibecode/by/zc277584121/marketing-skills.md) — 13 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
