webpronl/reveal-md

镜像概述

reveal-md 是一款基于 reveal.js 的增强工具，旨在简化演示文稿的创建流程。它允许用户直接使用 Markdown 语法编写内容，自动转换为具有专业视觉效果的 reveal.js 演示文稿，无需手动配置复杂的 HTML/CSS 结构。

核心功能与特性

• 原生 Markdown 支持：全面兼容标准 Markdown 语法及扩展语法（如表格、代码块、数学公式、脚注等）
• 实时预览与热重载：修改 Markdown 文件时自动刷新演示文稿，提供即时编辑反馈
• 主题与样式定制：内置 11 种 reveal.js 官方主题，支持自定义 CSS 和 SCSS 样式覆盖
• 插件生态兼容：无缝集成 reveal.js 插件系统，支持动画、图表、思维导图等扩展功能
• 多格式导出：支持导出为 PDF、静态 HTML、PNG 图像等格式，满足不同分发需求
• 多文件与目录管理：支持单文件演示或多章节目录结构，自动生成导航菜单
• 演讲者模式：提供演讲者备注视图，显示当前/下一张幻灯片及演讲笔记

使用场景与适用范围

• 技术演示：开发人员快速创建包含代码示例、架构图的技术分享材料
• 教育培训：教师、学生制作课堂讲义、学术报告，利用 Markdown 简化内容编写
• 会议演讲：演讲者高效准备会议报告，支持离线预览和多设备同步
• 文档展示：将 API 文档、产品手册等 Markdown 文档转换为交互式演示
• 团队协作：基于 Git 版本控制的 Markdown 文件协作，简化多人编辑流程

使用方法与配置说明

基础使用（Docker Run 命令）

通过以下命令启动容器，将本地 Markdown 文件转换为演示文稿：

bash
docker run -d -p 1948:1948 -v $(pwd):/slides webpro/reveal-md presentation.md

参数说明：

• -p 1948:1948：映射容器默认端口 1948 到主机，通过 http://localhost:1948 访问
• -v $(pwd):/slides：挂载当前目录到容器 /slides 目录，确保容器可访问 Markdown 文件
• presentation.md：指定要渲染的 Markdown 文件路径（相对于挂载目录）

高级启动参数

通过命令行参数自定义演示文稿属性：

bash
docker run -d -p 1948:1948 -v $(pwd):/slides webpro/reveal-md presentation.md \
  --theme league \          # 使用 "league" 主题（可选值：black/white/league/sky/beige/simple/serif/blood/night/moon/solarized）
  --transition convex \     # 设置幻灯片过渡效果（可选值：none/fade/slide/convex/concave/zoom）
  --port 8080 \             # 修改容器内服务端口（需同步调整 -p 映射）
  --watch \                 # 启用文件监听，自动刷新修改
  --separator '^\n---\n

### Docker Compose 配置示例

创建 `docker-compose.yml` 实现持久化部署：

```yaml
version: '3.8'
services:
  reveal-md:
    image: webpro/reveal-md
    container_name: reveal-md-demo
    ports:
      - "1948:1948"
    volumes:
      - ./slides:/slides        # 本地幻灯片目录挂载
      - ./custom-themes:/themes # 自定义主题目录（可选）
    command: main.md --theme /themes/my-theme.css --watch
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

演示文稿导出

导出为静态 HTML

bash
docker run -v $(pwd):/slides webpro/reveal-md presentation.md --export /slides/export

导出文件将保存到本地 export 目录，可直接部署到静态服务器。

导出为 PDF

bash
docker run -v $(pwd):/slides webpro/reveal-md presentation.md --print /slides/output.pdf

注意：PDF 导出需确保容器内 Chrome 环境正常，部分系统可能需要额外配置 --chrome-path 参数

注意事项

• Markdown 文件路径需相对于容器挂载目录，避免路径引用错误
• 自定义主题文件需通过卷挂载到容器，并使用绝对路径指定（如 --theme /themes/custom.css）
• 大型演示文稿或复杂公式可能需要增加容器内存限制
• 完整功能与最新更新请参考官方文档：https://github.com/webpro/reveal-md # 自定义幻灯片分隔符（默认：---）

### Docker Compose 配置示例

创建 __CODE_TOKEN_11__ 实现持久化部署：

__CODE_TOKEN_2__

启动服务：
__CODE_TOKEN_3__

### 演示文稿导出

#### 导出为静态 HTML
__CODE_TOKEN_4__
导出文件将保存到本地 __CODE_TOKEN_12__ 目录，可直接部署到静态服务器。

#### 导出为 PDF
__CODE_TOKEN_5__
> 注意：PDF 导出需确保容器内 Chrome 环境正常，部分系统可能需要额外配置 __CODE_TOKEN_13__ 参数

## 注意事项

- Markdown 文件路径需相对于容器挂载目录，避免路径引用错误
- 自定义主题文件需通过卷挂载到容器，并使用绝对路径指定（如 __CODE_TOKEN_14__）
- 大型演示文稿或复杂公式可能需要增加容器内存限制
- 完整功能与最新更新请参考官方文档：https://github.com/webpro/reveal-md