slidef

KO | EN

gitlite — search

#python #react #ai #typescript #go #android #linux #java #awesome #awesome-list #vue #security #ios #openai

(★ 34)

Slidef is a CLI tool that converts your PDF presentations into a modern, web-based slide viewer. Perfect for sharing presentations, creating slide archives, or building your own slide hosting platform.

slidef 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Slidef

**Transform your PDF presentations into beautiful web slides**

[![npm version](https://img.shields.io/npm/v/@slidef/cli.svg)](https://www.npmjs.com/package/@slidef/cli)
[![npm downloads](https://img.shields.io/npm/dm/@slidef/cli.svg)](https://www.npmjs.com/package/@slidef/cli)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[Installation](#installation) • [Quick Start](#quick-start) • [Features](#features) • [Documentation](#commands)

</div>

---

Slidef is a CLI tool that converts your PDF presentations into a modern, web-based slide viewer. Perfect for sharing presentations, creating slide archives, or building your own slide hosting platform.

## 🎬 Showcase

- [kciter.so/talks](https://kciter.so/talks/) - Personal presentation archive

## ✨ Features

- 🎯 **PDF to Images** - Automatically converts PDF slides to high-quality images (WebP, PNG, or JPEG)
- 📦 **Optimized File Size** - WebP format by default for 60% smaller files while maintaining quality
- 🖥️ **Web Viewer** - Beautiful, responsive slide viewer with keyboard navigation
- 🔥 **Dev Server** - Live development server with hot reload
- 🚀 **Static Export** - Generate static sites for easy deployment (GitHub Pages, Netlify, etc.)
- 🌐 **Subdirectory Deployment** - Support for deploying to subdirectories with baseUrl configuration
- ✏️ **Slide Management** - Edit slide metadata, titles, descriptions, and dates via web UI
- 🎨 **Theme Customization** - Customize colors and fonts to match your brand

## 📦 Installation

```bash
npm install -g @slidef/cli
```

or using pnpm:

```bash
pnpm add -g @slidef/cli
```

## 🚀 Quick Start

### 1. Initialize a new project

```bash
mkdir my-slides
cd my-slides
slidef init
```

This creates:
```
my-slides/
├── slidef.config.json
├── slides/
└── .gitignore
```

### 2. Import your first PDF

```bash
slidef import presentation.pdf
```

Your slides will be converted and saved to:
```
slides/
└── presentation/
    ├── images/
    │   ├── slide-001.webp
    │   ├── slide-002.webp
    │   └── ...
    └── metadata.json
```

### 3. Start the dev server

```bash
slidef dev
```

Open http://localhost:3000 to view your slides!

### 4. Publish as static site

```bash
slidef publish
```

Your static site will be generated in the `public/` directory, ready to deploy anywhere.

## 📚 Commands

### `slidef init`

Initialize a new Slidef project in the current directory.

**Options:**
- `--title <title>` - Set the project title (default: "Slide Presentations")
- `--subtitle <subtitle>` - Set the project subtitle

**Example:**
```bash
slidef init --title "My Presentations" --subtitle "Conference talks and workshops"
```

### `slidef import <pdf-file>`

Import and convert a PDF file to slides.

**Options:**
- `--name <name>` - Custom name for the slide deck (default: PDF filename)
- `--scale <number>` - Image resolution scale factor (default: 2)
- `--format <format>` - Image format: png, jpeg, or webp (default: webp)
- `--quality <number>` - Image quality for lossy formats (0-100, default: 85)

**Examples:**
```bash
# WebP with default quality (recommended)
slidef import talk.pdf --name "my-conference-talk"

# PNG for maximum quality
slidef import talk.pdf --format png

# JPEG with custom quality
slidef import talk.pdf --format jpeg --quality 90
```

### `slidef dev`

Start a development server with live reload.

**Options:**
- `--port <port>` - Server port (default: 3000)
- `--slides <dir>` - Slides directory (default: "slides")

**Example:**
```bash
slidef dev --port 8080
```

**Features:**
- Web-based slide management (import, edit, delete)
- Live reload on file changes
- Theme preview

### `slidef publish`

Generate a static site for deployment.

**Options:**
- `--output <dir>` - Output directory (default: "public")
- `--slides <dir>` - Slides directory (default: "slides")

**Example:**
```bash
slidef publish --output dist
```

## Configuration

The `slidef.config.json` file allows you to customize your slide viewer:

```json
{
  "title": "My Slide Presentations",
  "subtitle": "View and manage your slide decks",
  "publishDir": "public",
  "slidesDir": "slides",
  "theme": {
    "primaryColor": "#007bff",
    "progressColor": "#A020F0",
    "fontFamily": "system-ui, -apple-system, sans-serif"
  }
}
```

### Theme Options

- `primaryColor` - Primary accent color for buttons and links
- `backgroundColor` - Background color for the viewer
- `textColor` - Primary text color
- `progressColor` - Progress bar color
- `fontFamily` - Font family for the entire UI

## Slide Metadata

Each slide deck has a `metadata.json` file with the following structure:

```json
{
  "name": "presentation",
  "title": "My Awesome Presentation",
  "description": "A talk about something interesting",
  "pageCount": 42,
  "createdAt": "2025-11-05",
  "sha256": "abc123..."
}
```

You can edit `title`, `description`, and `createdAt` through the web UI in dev mode.

## 🌍 Deployment

### GitHub Pages

#### Option 1: Custom Domain or Root Site (username.github.io)

1. Publish your slides:
   ```bash
   slidef publish --output docs
   ```

2. Push to GitHub and enable GitHub Pages from the `docs` folder in repository settings.

#### Option 2: Project Repository (github.io/repo-name)

If your site will be deployed to a subdirectory (e.g., `https://username.github.io/my-slides/`):

1. Set the baseUrl in your `slidef.config.json`:
   ```json
   {
     "baseUrl": "/my-slides"
   }
   ```

2. Publish your slides:
   ```bash
   slidef publish --output docs
   ```

3. Push to GitHub and enable GitHub Pages from the `docs` folder in repository settings.

### Netlify / Vercel

1. Publish your slides:
   ```bash
   slidef publish
   ```

2. Deploy the `public/` directory using Netlify or Vercel.

## 🤝 Contributing

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

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

slidef

slidef 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

slidef

slidef 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README