RISE开源项目使用教程

RISE开源项目使用教程

RISE RISE: "Live" Reveal.js Jupyter/IPython Slideshow Extension 项目地址: https://gitcode.com/gh_mirrors/ri/RISE

1. 项目目录结构及介绍

RISE项目的主要目录结构如下：

RISE/
├── .github/
├── binder/
├── classic/
├── doc/
├── examples/
│   └── example_notebook.ipynb
├── rise-reveal/
│   ├── css/
│   ├── js/
│   └── server/
├── tests/
├── themes/
├── .gitignore
├── README.md
├── LICENSE.md
└── .readthedocs.yml

• .github/: 存放GitHub相关的配置文件。
• binder/: 可能包含用于在Binder上运行项目的配置文件。
• classic/: 可能包含用于Jupyter经典笔记本的静态文件。
• doc/: 包含项目文档的源文件。
• examples/: 存放示例Jupyter笔记本文件，用于演示RISE的使用。
• rise-reveal/: RISE扩展的核心目录，包含CSS、JS和服务器端代码。
• tests/: 包含用于测试RISE扩展的代码。
• themes/: 存放Reveal.js的主题文件。
• .gitignore: 指定Git忽略的文件和目录。
• README.md: 项目说明文件。
• LICENSE.md: 项目许可证文件。
• .readthedocs.yml: 用于配置Read the Docs的配置文件。

2. 项目的启动文件介绍

RISE项目的启动主要是通过在Jupyter笔记本中加载rise-reveal扩展来实现的。以下是在Jupyter笔记本中启动RISE的基本步骤：

1. 打开Jupyter笔记本。
2. 在一个代码单元中运行以下命令来加载RISE扩展：

%load_ext rise

3. 使用以下命令将当前笔记本转换为Reveal.js幻灯片：

%rise

3. 项目的配置文件介绍

RISE扩展使用Jupyter笔记本的元数据（metadata）来配置幻灯片。以下是一些常用的配置项：

• slide_number: 是否显示幻灯片编号。
• theme: 使用的Reveal.js主题。
• highlight: 是否高亮显示代码。
• scroll: 是否允许在幻灯片上滚动。

配置这些选项，你需要在Jupyter笔记本的元数据中添加相应的键值对。例如：

{
 "rise": {
  "theme": "moon",
  "highlight": true,
  "scroll": false
 }
}

确保在Jupyter笔记本的顶部添加这些配置，然后重新启动Jupyter笔记本以应用更改。

RISE RISE: "Live" Reveal.js Jupyter/IPython Slideshow Extension 项目地址: https://gitcode.com/gh_mirrors/ri/RISE