ryanj/gist-reveal

gist-reveal

Gist-reveal 是一款幻灯片模板服务，可利用 GitHub 的 http://gist.github.com 服务作为数据存储，查看和分享基于 https://github.com/hakimel/reveal.js 的演示文稿。

可访问以下地址试用：[***]

Gist 驱动的 Reveal.js 演示文稿

在 http://gist.github.com 中存储 reveal.js 的 HTML 或 Markdown <section> 内容，然后将生成的 gist ID 附加到任意 gist-reveal 站点 URL 即可查看幻灯片：

[***]

示例：

[***]

使用 bit.ly 或其他 URL 缩短服务可简化长 URL，便于分享和跟踪访问数据。

广播幻灯片切换

演示者可访问 /login 将浏览器配置为演示设备：

[***]

警告：仅 gist 所有者允许向观众广播幻灯片切换。如需使用他人幻灯片进行演示，可 Fork 幻灯片并使用新的 gist ID。详细信息可查看 Web 控制台输出。

访问 /logout 退出演示模式：

[***]

Gist 驱动的主题

使用 "?theme=" 查询参数访问站点主题。可用的 CSS 主题 包括默认的 reveal.js 主题 列表：

• reveal.js black 主题
• reveal.js simple 主题
• reveal.js league 主题
• reveal.js sky 主题

也可通过 另一个 gist 加载自定义主题。例如：

• 深色冬季主题

更友好的演示路径

为较长的 gist-reveal/gist_id 演示 URL 创建 bit.ly 短链接后，演示文稿也可通过以下替代路径访问：

[***]

示例：

[***]

建议继续使用较短的 bit.ly/短链接名称 URL 以方便流量统计。

使用场景与适用范围

• 快速创建与分享演示文稿：适合需要通过简单编辑 Gist 内容快速生成演示文稿，并通过 URL 直接分享的用户。
• 远程演示与同步：支持演示者控制幻灯片切换并同步到所有观众端，适用于线上会议、远程教学等场景。
• 主题定制需求：提供多种内置主题，并支持通过 Gist 自定义主题，满足个性化演示风格需求。

使用方法与配置说明

基本使用

1. 创建演示文稿：在 GitHub Gist 中创建包含 reveal.js HTML 或 Markdown <section> 内容的文件。
2. 访问幻灯片：通过 https://gist-reveal.it/你的GIST_ID 查看演示文稿。
3. 广播控制（可选）：访问 https://gist-reveal.it/login 配置为演示设备以广播幻灯片切换；结束后访问 https://gist-reveal.it/logout 退出。
4. 主题设置（可选）：在 URL 后添加 ?theme=主题名称 或 ?theme=自定义主题GIST_ID 应用主题，例如 https://gist-reveal.it/af84d40e58c5c2a908dd?theme=sky。

应用配置

通过以下环境变量配置 gist-reveal 服务：

注意：启用 WebSocket 连接需配置 GitHub OAuth 应用，CLIENT_ID 和 CLIENT_SECRET 为必需项，且重定向 URL 需设置为 你的站点域名/github/callback。

本地开发

1. 安装依赖：

   bash
   npm install
   

2. 启动服务：

   bash
   npm start
   

3. 生成本地 HTTPS 证书（可选，用于测试 HTTPS 和 WebSocket 连接）：

   bash
   openssl req -x509 -out public.crt -keyout private.key \
     -newkey rsa:2048 -nodes -sha256 \
     -subj '/CN=localhost' -extensions EXT -config <( \
      printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
   

本地开发（加载本地幻灯片）

如需通过本地编辑器开发幻灯片，可加载本地 Gist 仓库：

1. 克隆 Gist 仓库：

   bash
   git clone git@gist.github.com:你的GIST_ID ../本地幻灯片目录
   

2. 加载本地幻灯片：

   bash
   GIST_PATH=../本地幻灯片目录 GIST_FILENAME=幻灯片文件名.html npm start
   

3. 更新与部署：编辑完成后，提交并推送 Gist 仓库即可更新线上演示文稿。

容器部署

使用 Docker 或 Podman 在本地端口 8080 运行容器：

bash
docker run --rm -p 8080:8080 ryanj/gist-reveal

通过环境变量自定义配置（如默认 Gist ID 或主题）：

bash
docker run --rm -p 8080:8080 -e "DEFAULT_GIST=你的默认GIST_ID" ryanj/gist-reveal

Kubernetes 部署

创建名为 gist-reveal 的 Kubernetes Pod 和 Service：

bash
kubectl run gist-reveal --image=ryanj/gist-reveal --expose --port=8080 \
--env="DEFAULT_GIST=你的默认GIST_ID" \
--env="GH_API_TOKEN=你的GitHub_API令牌" \
--env="CLIENT_SECRET=你的GitHub_OAuth客户端密钥" \
--env="CLIENT_ID=你的GitHub_OAuth客户端ID"

许可证

gist-reveal 由 https://github.com/ryanj 和 https://github.com/fkautz 在首届 DockerCon Hackathon 上创建。

https://github.com/hakimel/reveal.js 采用 MIT 许可证
版权所有 (C) 2014 Hakim El Hattab, [***]