Installation

Installing mkdocs-nbsync is straightforward and can be done using uv or pip, the Python package manager.

Prerequisites

Before installing nbsync, ensure you have the following:

• Python 3.10 or higher
• uv or pip (Python package manager)
• MkDocs 1.6 or higher (documentation generator)

Basic Installation

Install mkdocs-nbsync using uv or pip:

uv pip install mkdocs-nbsync
# or
pip install mkdocs-nbsync

This command installs the latest stable version of mkdocs-nbsync and its core dependencies.

Installation of nbconvert

For dynamic execution functionality, install nbconvert:

uv pip install nbconvert
# or
pip install nbconvert