swarmauri_tool_jupyterexportmarkdown 0.11.0.dev1

Swarmauri Markdown publishing tool for converting Jupyter notebooks into documentation-ready Markdown.

Swarmauri Jupyter Export Markdown Tool

swarmauri_tool_jupyterexportmarkdown converts a Jupyter notebook dictionary into Markdown using nbconvert.MarkdownExporter, with optional template selection and inline style resources for static publishing workflows.

Why

• Convert notebooks into documentation-friendly Markdown.
• Feed notebook output into static-site, docs, and content pipelines.
• Keep notebook-to-Markdown generation inside a Swarmauri tool interface.

Features

• Accepts notebook content as a Python dictionary.
• Normalizes list-based cell sources before export.
• Exports with nbconvert.MarkdownExporter.
• Supports optional custom templates.
• Supports optional style resources for embedded export customization.

FAQ

What kind of input does this tool expect?

It expects a JSON-like Python dictionary representing a notebook, not a raw file path and not a JSON string.

Does it write a .md file?

No. It returns Markdown content in exported_markdown.

What is the styles argument for?

It lets callers pass style content into the nbconvert resources structure for custom Markdown export workflows.

Installation

uv add swarmauri_tool_jupyterexportmarkdown

pip install swarmauri_tool_jupyterexportmarkdown

Usage

from swarmauri_tool_jupyterexportmarkdown import JupyterExportMarkdownTool

notebook = {
    "cells": [
        {"cell_type": "markdown", "metadata": {}, "source": ["# Demo"]},
        {
            "cell_type": "code",
            "metadata": {},
            "execution_count": None,
            "outputs": [],
            "source": ["print('hello')"],
        },
    ],
    "metadata": {},
    "nbformat": 4,
    "nbformat_minor": 5,
}

result = JupyterExportMarkdownTool()(notebook_json=notebook)
print(result["exported_markdown"])

Examples

Export Markdown with a custom template

result = JupyterExportMarkdownTool()(
    notebook_json=notebook,
    template="lab",
)

Export Markdown with custom styles

result = JupyterExportMarkdownTool()(
    notebook_json=notebook,
    styles="pre { font-size: 0.9rem; }",
)

Related Packages

• swarmauri_tool_jupyterexporthtml
• swarmauri_tool_jupyterexportlatex
• swarmauri_tool_jupyterexportpython
• swarmauri_tool_jupyterexecuteandconvert
• swarmauri_tool_jupyterreadnotebook

Foundational Swarmauri Packages

• swarmauri
• swarmauri_core
• swarmauri_base
• swarmauri_standard

More Documentation

• Swarmauri SDK repository
• nbconvert Markdown exporter docs
• Jupyter documentation