create-marp-slides

CLI tool for scaffolding Marp presentation projects with GitHub Pages deployment.

Features

• 🚀 Quick Setup: Create a new Marp presentation project in seconds
• 📝 Markdown-based: Write slides in Markdown with Marp syntax
• 🎨 Beautiful Themes: Built-in Marp themes and styling
• 🔄 Auto-deploy: GitHub Actions workflow for automatic deployment to GitHub Pages
• 📱 Responsive: Mobile-friendly slide presentations
• 🔧 Zero Configuration: Works out of the box with sensible defaults

Installation

No installation required! Use directly with npx:

npx create-marp-slides my-presentation

Usage

Create a new presentation

# Create with project name
npx create-marp-slides my-slides

# Interactive mode (prompts for project name)
npx create-marp-slides

# Skip dependency installation
npx create-marp-slides my-slides --skip-install

After creation

1. Navigate to your project directory:

   cd my-slides

2. Install dependencies (if skipped):

   npm install

3. Start development server:

   npm run dev

4. Build for production:

   npm run build

Generated Project Structure

my-slides/
├── slides.md              # Your presentation content
├── package.json           # Project configuration
├── .gitignore             # Git ignore rules
└── .github/
    └── workflows/
        └── deploy.yml      # GitHub Actions for auto-deployment

Development Commands

• npm run dev - Start development server with live reload
• npm run build - Build slides to static HTML
• npm run preview - Preview built slides locally

Deployment to GitHub Pages

1. Push your project to GitHub
2. Go to repository Settings > Pages
3. Set Source to "GitHub Actions"
4. Edit slides.md and push changes
5. Your slides will be automatically deployed! 🎉

Marp Syntax

The generated slides.md includes examples of:

• Slide separators (---)
• Themes and styling
• Math formulas (KaTeX)
• Code highlighting
• Images and media
• Speaker notes

Learn more about Marp syntax at marp.app

Requirements

• Node.js 16.0.0 or higher
• npm or yarn

Contributing

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

License

MIT License - see LICENSE file for details.

Related

• Marp - Markdown Presentation Ecosystem
• Marp CLI - CLI interface for Marp
• GitHub Pages - Static site hosting