jupyter-mkslides

An nbconvert custom exporter that converts Jupyter Notebooks (.ipynb) into Markdown for mkslides.

Installation

pip install -e .

Usage

jupyter nbconvert --to mkslides presentation.ipynb

This generates presentation.md along with presentation_files/, which contains the extracted image outputs. The generated Markdown can be fed directly to mkslides.

mkslides build presentation.md
# or
mkslides serve presentation.md

Cell metadata handling

Each cell is converted according to its metadata.slideshow.slide_type (set via the Slideshow toolbar in Jupyter):

Turning subslides into vertical slides

The default mkslides (reveal.js) configuration has no vertical slide separator, so subslide cells are output as regular slide breaks (---) by default. To use vertical slides, pass the option at conversion time:

jupyter nbconvert --to mkslides --MkSlidesExporter.subslide_as_vertical=True presentation.ipynb

and enable the vertical separator in your mkslides.yml:

slides:
  separator_vertical: '^\s*-v-\s*$'

Image outputs of code cells (image/png, etc.) are saved to {notebook name}_files/ by nbconvert's standard ExtractOutputPreprocessor and linked as ![png](...).

日本語版は README_ja.md を参照してください。