🛩️ Slide-Deck-CLI

The Markdown to Presentation Engine

Transform your Markdown into stunning, interactive Reveal.js presentations in seconds.

📽️ Demo

Note: Imagine a sleek GIF here showing a side-by-side terminal and browser. The terminal runs slide-deck talk.md, and the browser instantly renders a beautiful slide. As the code is edited, the browser refreshes flawlessly.

🔥 Why Slide-Deck-CLI?

Most presentation tools are either too complex (PowerPoint/Keynote) or too rigid (basic Markdown engines). Slide-Deck-CLI gives you the best of both worlds:

✍️ Write in Markdown: Focus on content, not formatting.
✨ Reveal.js Magic: Access high-end transitions, vertical slides, and mobile-friendly touch support.
🔄 Hot Reload: Real-time feedback loop. Save → See → Succeed.
📦 Zero Config: It just works. But it's also highly extensible.

🛠️ Features

⚡ Near-Instant Live Reload: Powered by WebSockets for sub-millisecond updates.
🎨 Code Syntax Highlighting: Automatic language detection for your snippets.
📄 Export to PDF: Professional-quality handouts using Puppeteer's headless engine.
🚀 Static Site Generator: One-command export for GitHub Pages or Netlify.
🛡️ Built-in Quality: CI/CD ready with pre-commit hooks to keep your repo pristine.

🚀 Getting Started

Installation

# Clone the universe
git clone https://github.com/bradmca/slide-deck-cli.git
cd slide-deck-cli

# Install dependencies
npm install

# Link to your system
npm link

Usage

# Start the magic
slide-deck presentation.md

# Custom port
slide-deck presentation.md --port 9000

# Export for the boss (PDF)
slide-deck presentation.md --pdf

# Build for the web (Static site)
slide-deck presentation.md --build

📐 How It Works

graph LR
  A[Markdown File] --> B[CLI Parser]
  B --> C{Action}
  C -->|Preview| D[Express Server + WS]
  C -->|Export| E[Puppeteer]
  C -->|Build| F[Static Asset Bundler]
  D --> G[Reveal.js UI]
  E --> H[PDF Document]
  F --> I[dist/ Folder]

🤝 Contributing & Community

We believe in high-quality code and respectful collaboration.

Contributing Guide: How to set up your dev environment.
Code of Conduct: Our promise to keep this community safe.
Security Policy: Reporting vulnerabilities.
Issue Templates: Helping us help you.

🛡️ Pre-Commit Quality Checks

We hate broken builds. This repo comes with Husky and lint-staged:

On Commit: Automatically runs ESLint and Prettier on changed files.
On Push: Automatically runs the Jest test suite.
On GitHub: Full CI suite ensures every PR is high-quality.

📄 License

This project is licensed under the MIT License. Build something awesome!

⭐ If this project helps you, please give it a star!

FilesExpand file tree

README.md

Latest commit

History