ipyslides 6.9.8

Live rich content slides in jupyter notebook

IPySlides

IPySlides is a Python library for creating interactive presentations in Jupyter notebooks. It combines the power of Markdown, LaTeX, interactive widgets, and live variable updates in a single presentation framework.

---

---

Features

• 📊 Support for plots, widgets, and rich media
• 🎨 Customizable themes and layouts
• 📱 Responsive design for various screen sizes
• 📤 Export to HTML/PDF (limited content type)
• 🎯 Frame-by-frame animations
• 📝 Speaker notes support
• 🔄 Markdown, citations and settings files synchronization
• ✏️ Drawing support during presentations

---

Quick Start

1. Install:

pip install ipyslides        # Basic installation
pip install ipyslides[extra] # Full features

2. Create Slides:

import ipyslides as isd
slides = isd.Slides()

# Add content programmatically
slides.build(-1, """
# My First Slide
- Point 1
- Point 2
$E = mc^2$
""")

# Or use cell magic
%%slide 0
# Title Slide
Welcome to IPySlides!

3. Run Examples:

slides.docs()  # View documentation
slides.demo()  # See demo presentation

✨ Try it in your browser ✨

Jupyterlite	Binder

---

Content Types

Support for various content types including:

• 📜 Extended Markdown, see slides.xmd_syntax
• 📊 Plots (Matplotlib, Plotly, Altair)
• 🔧 Interactive Widgets
• 📷 Images and Media
• ➗ LaTeX Equations
• ©️ Citations and References
• 💻 Auto update variables in markdown
• 🎥 Videos (YouTube, local)
• 🎮 Enhanced interactive widgets (with fullscreen support, thanks to anywidget)

import numpy as np
from ipywidgets import HTML

@slides.dl.interact(html = HTML(), amplitude= (0, 2),frequency=(0, 5))
def plot(html, amplitude, frequency):
    x = np.linspace(0, 2*np.pi, 100)
    y = amplitude * np.sin(frequency    * x)
    plt.plot(x, y)
    html.value = slides.plt2html(). value

• For comprehensive dashbords, subclass DashboardBase or use Dashboard from ipyslides.dashlab:

import numpy as np
import matplotlib.pyplot as plt
from ipywidgets import HTML
from ipyslides.dashlab import Dashboard

dash = Dashboard(
    html = HTML(),
    amplitude = (0, 2),
    frequency = (0, 5),
)

@dash.callback
def plot(self, html, amplitude, frequency):
    x = np.linspace(0, 2*np.pi, 100)
    y = amplitude * np.sin(frequency * x)
    plt.plot(x, y)
    html.value = slides.plt2html().value # can be directly shown on out-main

@dash.callback('out-text')
def text(self, amplitude, frequency):
    print(f"Amplitude: {amplitude}\n Frequency: {frequency}")

dash.set_layout( 
    left_sidebar = ['*ctrl'], # all controls in left sidebar 
    center = ['html','out-.*'], # out-main, out-text collected in center
    pane_widths = [3,5,0]
)
dash.set_css(
    main = { # can also be set via post_init callback
        'grid-gap': '4px', 'margin': '8px',
        '.left-sidebar': {'background': '#eee','border-radius': '8px'},
    },
    center = { # can be set in main through '> .center' selector
        '> *': {'background-color': 'whitesmoke', 'border-radius': '8px','padding':'8px'},
        'grid-template-columns': '5fr 3fr', # side-by-side layout for outputs
        'grid-gap': '4px', # central grid gap
        '> *': {'background-color': 'whitesmoke', 'border-radius': '8px','padding':'8px'}
})
display(dash)

See more examples in DashLab repository and try it out in

• And much more!

---

Export Options

• HTML Export
  Use slides.export_html to build static slides that you can print to PDF. Read export details in settings panel, where you can also export with a single click.

• PDF Export Support for direct PDF printing from slides using Ctrl + P (use options in side panel to prepare for print) is available, although some IDEs like VSCode may not allow it. Use Save as PDF option and enable background graphics if necessary. If issues arise in direct printing, consider exporting to HTML first and printing from there.

Navigate to Documentation to see HTML slides which you can print to PDF. See demo.pdf for an example exported PDF.

---

Advanced Features

• Custom Objects Serialization:

  • You can serialize custom objects to HTML using Slides.serializer API.
  • You can extend markdown syntax using Slides.extender API. See some good extensions to add from PyMdown.

• Speaker Notes: Enable via Settings Panel → Show Notes and add notes via slides.notes.

• Custom Styling:

slides.set_css({ # on all slides or slide[index,].set_css() per slide
    'p': {'font-size':'1.2em', 'line-height':'1.5em'}, # relaxed paragraph
}, bg1 = '#f0f0f0') # set theme color on this slide

• File Sync: Live edit a linked markdown file that updates slides in real-time using slides.sync_with_file.

• Content Animations:

  • Slides builders now support skeleton animation automatically for a premium editing experience.
  • Beside slides switch transitions, you can animate content anywhere in slides using anim- prefixed classes and related varaiables. See slides.css_animations for details.

---

Caveats

1. Markdown Cells:

   • Jupyter markdown cells are not processed by IPySlides
   • Instead, you can use %%slide number -m cell magic and link an external markdown file using slides.sync_with_file

2. Slide Numbering:

   • Use -1 for automatic slide numbering
   • Manual numbering requires careful tracking to avoid overwriting slides

3. Speaker Notes:

   • Experimental feature - use with caution
   • Notes appear at top of slide in PDF to grab speaker's attention and are meant for speaker reference only, e.g. printed handout.
   • Place extended projector on top/bottom of laptop screen while presenting in Jupyter Notebook to allow right/left edges click navigation work smoothly.

---

Development

git clone https://github.com/asaboor-gh/ipyslides.git
cd ipyslides
pip install -e .

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

---

Documentation

• Github Pages Documentation
• Full documentation: slides.docs() same as on github pages.
• Examples: slides.demo()
• GitHub Repository

Acknowledgements

• ipywidgets & anywidget
• IPython
• Python-Markdown

---

Made with ❤️ by Abdul Saboor