🪐 A tool to convert Jupyter Notebooks to slide shows.

• 📖 Frontend written in Vue.js and TypeScript
• 💻 Backend written in Go
• 🖼️ Supports loading images
• 📄 Fast Markdown parsing with markdown-it
• 🎨 Code highlighting with Shiki with customizable theme

Go and pnpm are required

1. Clone the repository

git clone https://github.com/ProCode-Software/jupyter-slides.git
cd jupyter-slides

2. Run the ./install.sh script to build from source and install jupyter-slides into ~/.jupyter-slides. To install into a different location, run JS_DIR=folder ./install.sh

jupyter-slides [--port <port>] <notebook>

• port: Localhost port number to host the server on
• notebook: (Required) Path to Jupyter Notebook

To uninstall jupyter-slides, just delete the ~/.jupyter-slides folder.

Clone the repo:

git clone https://github.com/ProCode-Software/jupyter-slides.git
cd jupyter-slides
pnpm install
pnpm run dev

Create a notebook.ipynb file in the folder for testing. Then open http://localhost:5173 to view (this uses Vite's dev server).

MIT License