Jupyter2Slides 项目使用指南

1. 项目目录结构及介绍

jupyter2slides/
├── decktape-1.0.0/
├── static/
│   └── presentation_template.ipynb
├── .cfignore
├── .gitignore
├── LICENSE
├── README.md
├── create_slides.py
├── environment.yml
├── manifest.yml
├── requirements.txt
└── run.py

目录结构说明

• decktape-1.0.0/: 用于将 Reveal.js 幻灯片转换为 PDF 的工具。
• static/: 包含演示文稿的模板文件 presentation_template.ipynb。
• .cfignore: 用于 Cloud Foundry 部署时忽略的文件列表。
• .gitignore: 用于 Git 版本控制时忽略的文件列表。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• create_slides.py: 用于生成 Reveal.js 幻灯片的 Python 脚本。
• environment.yml: 用于创建 Conda 环境的配置文件。
• manifest.yml: 用于 Cloud Foundry 部署的配置文件。
• requirements.txt: 项目的依赖包列表。
• run.py: 用于在本地启动幻灯片服务的 Python 脚本。

2. 项目启动文件介绍

run.py

run.py 是用于在本地启动幻灯片服务的启动文件。通过运行该脚本，可以在本地浏览器中查看生成的 Reveal.js 幻灯片。

使用方法

python run.py --file static/presentation_template.slides.html

该命令会在本地启动一个服务器，并打开浏览器显示幻灯片。

3. 项目的配置文件介绍

environment.yml

environment.yml 是用于创建 Conda 环境的配置文件。通过该文件，可以快速创建一个包含项目所需依赖的环境。

使用方法

conda env create -f environment.yml

manifest.yml

manifest.yml 是用于 Cloud Foundry 部署的配置文件。通过该文件，可以将项目部署到云端。

使用方法

cf push

requirements.txt

requirements.txt 是项目的依赖包列表。通过该文件，可以快速安装项目所需的所有 Python 依赖包。

使用方法

pip install -r requirements.txt

通过以上介绍，您可以快速了解并使用 Jupyter2Slides 项目来创建和展示基于 Jupyter Notebook 的幻灯片。