skills.rest
quarcs-lab
quarcs-labOFFICIAL
Explore all skills by this author →
WebsiteGitHub

sync-notebooks

Synchronize Jupytext paired .ipynb and Markdown .md files with uv run jupytext --sync.

Updated Mar 7, 2025
Search Tags:#automation#sync#notebooks#ipynb#md#pairing#jupytext
One-click install
npx skills add https://github.com/quarcs-lab/project2025s --skill sync-notebooks
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sync-notebooks
Source: https://github.com/quarcs-lab/project2025s/tree/main/.claude/skills/sync-notebooks
Command: npx skills add https://github.com/quarcs-lab/project2025s --skill sync-notebooks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps users keep paired notebooks in sync between Jupytext's .ipynb files and their MyST Markdown (.md) counterparts, preventing drift when edits occur in either format.

Core Features & Use Cases

  • Sync paired notebooks: align the .ipynb and .md versions for all listed notebooks.
  • Update & regenerate: apply edits in the Markdown files to regenerate the corresponding notebooks, or vice versa.
  • Use Case: maintain four notebooks in a project such that changes in any format automatically stay consistent.

Quick Start

Run uv run jupytext --sync on the notebooks/ directory to synchronize all paired files.

Frequently Asked Questions about sync-notebooks

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I sync Jupytext paired notebooks between .ipynb and .md formats?▼

To sync Jupytext paired notebooks, run uv run jupytext --sync on the notebooks/ directory to align both versions and prevent drift from edits made in either format.

What is the best way to update MyST Markdown files and regenerate corresponding Jupyter notebooks?▼

Updating MyST Markdown files to regenerate Jupyter notebooks is done by running jupytext --sync, which applies edits from the .md files to automatically rebuild the paired .ipynb files.

Does Jupytext notebook pairing work without installing additional dependencies?▼

Jupytext notebook pairing requires the jupytext package, invoked via uv run jupytext --sync, and assumes a project structure with notebooks/ and corresponding *.md files without needing other dependencies.

Can I batch sync multiple paired notebooks in a project directory?▼

You can batch sync multiple paired notebooks in a project directory by running uv run jupytext --sync on the notebooks/ folder, which aligns all listed .ipynb and .md versions simultaneously.

Why does my Jupytext paired notebook show different content between the .ipynb and .md files?▼

Jupytext paired notebooks show different content between .ipynb and .md files when edits occur in either format without synchronization, requiring a jupytext --sync run to realign both versions.

Related Skills

Explore More Software Engineering Skills→
ninehillsninehills
84

jupytext

Convert Jupyter Notebooks between .py and .ipynb formats.

Community
Intermediate
OpenHandsOpenHands
134

jupyter

Read, modify, execute, and convert Jupyter notebooks to HTML, Python, or Markdown.

Official
Intermediate
edwinhuedwinhu
19

jupytext

Synchronize Jupyter notebooks with plain text formats for Git version control.

Community
Intermediate
zhizhunbaozhizhunbao

learning-notebook_conversion

Convert Jupyter notebooks to Python scripts while preserving code and markdown.

Community
Basic