Deckrun: A Modern Presentation Utility for Markdown and Self-contained HTML

Introduction to Deckrun

Deckrun is a powerful, open-source presentation utility built by Arpit Bhayani, designed to simplify the creation and delivery of presentations using Markdown and self-contained HTML. Evolving from its predecessor, present-md, Deckrun addresses the need for a lightweight, flexible, and visually appealing alternative to traditional presentation software like Google Slides or Canva. It caters to developers and technical speakers who prefer the simplicity and efficiency of Markdown for content creation, while also supporting modern self-contained HTML documents often generated by AI tools.

Core Philosophy and Benefits

The core idea behind Deckrun is to provide a seamless experience for presenting technical content. Its benefits include:

• Markdown-centric Workflow: Leverage the simplicity of Markdown for rapid content creation.
• Self-contained HTML Support: Present rich, interactive HTML documents directly.
• Lightweight and Efficient: Avoid the bulkiness of traditional presentation tools.
• Agentic Workflow Integration: Easily generate Markdown-based presentations from articles using custom scripts.
• Open Source: Fully customizable and extensible, hosted on GitHub.

Installation and Getting Started

Deckrun offers flexible installation and usage options to suit different workflows.

Global Installation via npm

For a persistent installation, Deckrun can be installed globally using npm:

npm install -g deckrun

Once installed, simply run deckrun from your terminal to launch the editor:

deckrun

On-the-Fly Execution with npx

For quick, temporary use without a global installation, npx can be used:

npx deckrun

Presenting Local Markdown Files

To present a local Markdown file, pass its path to deckrun:

deckrun my-presentation.md

Presenting from a URL

Deckrun can directly load and present Markdown content from a raw URL, eliminating the need for local files:

deckrun <raw-markdown-url>

Example slides are available in the Deckrun GitHub repository under the examples directory.

The Deckrun Editor: Your Presentation Hub

The Deckrun editor is a powerful, intuitive interface for creating and managing your presentations.

Interface Overview

The editor provides a split-pane view: a Markdown editor on the left and a live preview of your slides on the right. Key elements include:

• Presentation Name: A field to name your presentation.
• Local Storage: All presentations are saved locally in your browser’s local storage, similar to Excalidraw, ensuring your work persists across sessions on the same device.
• Guide: A built-in guide details all supported Markdown elements, including headings, subheadings, bold text, syntax highlighting, and the ability to inject raw HTML.
• Insert Menu: Provides shortcuts to insert new slides, speaker notes, and other common elements without remembering specific Markdown syntax.

Theming and Customization

Deckrun offers extensive visual customization options:

• Themes: Choose from 14 pre-built themes, including 7 dark and 7 light modes (e.g., Midnight, Tokyo Night, Nord).
• Custom Themes: Instructions for creating and adding your own custom themes are available on GitHub.
• Font Customization: Adjust the font for both the title and body text (e.g., JetBrains Mono for titles).
• Font Size: Control the overall font size of the presentation (small, medium, large).

Export Options

Deckrun provides versatile export capabilities:

• Markdown File: Export your presentation as a raw Markdown file.
• PDF: Convert and download your presentation as a PDF document, suitable for submission or offline viewing.
• Self-contained HTML: Generate a single, self-contained HTML page of your presentation. This HTML file can be easily hosted (e.g., on Vercel) or shared directly, making it highly portable.

Presentation Mode: Engaging Your Audience

Once your presentation is ready, Deckrun’s presentation mode offers a suite of tools for dynamic delivery.

Navigation

• Keyboard Controls: Navigate slides using the left and right arrow keys.
• Slide Overview: Press Escape to view all slides and jump to a specific one.
• Help: Press ? to display a list of all keyboard shortcuts and controls.

Interactive Tools

• Laser Pointer: Activate a virtual laser pointer to highlight specific areas on your slides.
• Pen Tool: Draw directly onto the presentation canvas.
  • Persistent Drawings: Drawings remain on the slide even when navigating away and returning.
  • Customization: Change pen color and size.
  • Clear All: Clear all drawings from the canvas.
• Full Canvas Mode: Hide the current slide to focus entirely on the drawing canvas, useful for impromptu whiteboarding.
• Blackout: A feature suggested by Claude, which blacks out the screen. Its specific purpose is left to the presenter’s creativity.

Presenter Features

• Speaker Notes: Add private notes for each slide, visible only to the presenter.
• Presenter View: A dedicated view for the presenter, showing the current slide, next slide, and speaker notes.

Self-contained HTML Presentation

Beyond Markdown, Deckrun excels at presenting self-contained HTML documents. This feature is particularly useful for:

• AI-generated Content: Presenting rich HTML documentation or reports created by AI tools.
• Interactive Demos: Showcasing web-based applications or interactive content within a presentation framework.

The process involves uploading a self-contained HTML file, and Deckrun handles the rendering and presentation with the same tooling and features available for Markdown presentations.

Open Source and Community Contribution

Deckrun is an open-source project hosted on GitHub. Arpit encourages users to:

• Fork and Customize: Adapt the tool to their specific needs.
• Raise Issues: Report bugs or suggest new features.
• Submit Pull Requests: Contribute directly to the codebase, especially for interesting features.

Conclusion

Deckrun stands as a testament to the power of developer-built tools for enhancing productivity and presentation quality. By combining the simplicity of Markdown with the versatility of self-contained HTML, and offering a rich set of editing and presentation features, it provides a compelling solution for technical speakers and educators. Its open-source nature further ensures its evolution and adaptability to the community’s needs.